docs: update install instructions to pip install metaorm
This commit is contained in:
@@ -15,12 +15,12 @@ Async repository layer over [SQLModel](https://sqlmodel.tiangolo.com). Define a
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pip install "git+https://github.com/OlegYurchik/metaorm.git"
|
||||
pip install metaorm
|
||||
```
|
||||
|
||||
Requires Python `>=3.12`.
|
||||
|
||||
> **Note:** The package is installed directly from GitHub because `metaorm` depends on a patched version of `pydantic-filters` (from `so-saf/pydantic-filters`) that is not yet available on PyPI.
|
||||
> **Note:** `metaorm` depends on a patched version of `pydantic-filters` that is not yet available on PyPI. The dependency is pulled automatically from GitHub during installation.
|
||||
|
||||
## Quick start
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ classifiers = [
|
||||
]
|
||||
dependencies = [
|
||||
"pydantic>=2.0",
|
||||
"pydantic-filters @ git+https://github.com/OlegYurchik/pydantic-filters.git@fix/compare-to-pydantic-2.12",
|
||||
"pydantic-filters>=0.4.0",
|
||||
"sqlalchemy>=2.0",
|
||||
"sqlmodel>=0.0.22",
|
||||
]
|
||||
@@ -69,6 +69,3 @@ testpaths = ["tests"]
|
||||
[tool.coverage.report]
|
||||
fail_under = 90
|
||||
show_missing = true
|
||||
|
||||
[tool.uv.sources]
|
||||
pydantic-filters = { git = "https://github.com/OlegYurchik/pydantic-filters", branch = "fix/compare-to-pydantic-2.12" }
|
||||
|
||||
10
uv.lock
generated
10
uv.lock
generated
@@ -515,7 +515,7 @@ dev = [
|
||||
[package.metadata]
|
||||
requires-dist = [
|
||||
{ name = "pydantic", specifier = ">=2.0" },
|
||||
{ name = "pydantic-filters", git = "https://github.com/OlegYurchik/pydantic-filters?branch=fix%2Fcompare-to-pydantic-2.12" },
|
||||
{ name = "pydantic-filters", specifier = ">=0.4.0" },
|
||||
{ name = "sqlalchemy", specifier = ">=2.0" },
|
||||
{ name = "sqlmodel", specifier = ">=0.0.22" },
|
||||
]
|
||||
@@ -788,11 +788,15 @@ wheels = [
|
||||
|
||||
[[package]]
|
||||
name = "pydantic-filters"
|
||||
version = "0.0.0"
|
||||
source = { git = "https://github.com/OlegYurchik/pydantic-filters?branch=fix%2Fcompare-to-pydantic-2.12#2ca8b822d59feaf5f19f36b570974d314ba5e330" }
|
||||
version = "0.4.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "pydantic" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/7b/9b/291e0cec0d4b33cef16c734a41926dacf498a7c56b1ac9701b1c067d3f09/pydantic_filters-0.4.0.tar.gz", hash = "sha256:85715ad866e3c4233143717cb9f9a7d1a2ba1753b6bddb79a744e5b43b3b8149", size = 287826, upload-time = "2026-08-18T13:41:20.931Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/8d/2e/041b3c15b0b856f55469dac3c2a6982f25d1ce98a94b30a8a97a2dd69256/pydantic_filters-0.4.0-py3-none-any.whl", hash = "sha256:2ae2c04e1823f46502bb47d5724592f46e30895afbc58bd7abb11e30c934d14a", size = 20901, upload-time = "2026-08-18T13:41:19.983Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "pygments"
|
||||
|
||||
Reference in New Issue
Block a user