diff options
Diffstat (limited to '.venv/lib/python3.12/site-packages/postgrest-0.19.3.dist-info/METADATA')
| -rw-r--r-- | .venv/lib/python3.12/site-packages/postgrest-0.19.3.dist-info/METADATA | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/postgrest-0.19.3.dist-info/METADATA b/.venv/lib/python3.12/site-packages/postgrest-0.19.3.dist-info/METADATA new file mode 100644 index 00000000..824dee1e --- /dev/null +++ b/.venv/lib/python3.12/site-packages/postgrest-0.19.3.dist-info/METADATA @@ -0,0 +1,135 @@ +Metadata-Version: 2.1 +Name: postgrest +Version: 0.19.3 +Summary: PostgREST client for Python. This library provides an ORM interface to PostgREST. +Home-page: https://github.com/supabase/postgrest-py +License: MIT +Author: Lương Quang Mạnh +Author-email: luongquangmanh85@gmail.com +Requires-Python: >=3.9,<4.0 +Classifier: License :: OSI Approved :: MIT License +Classifier: Operating System :: OS Independent +Classifier: Programming Language :: Python :: 3 +Classifier: Programming Language :: Python :: 3.9 +Classifier: Programming Language :: Python :: 3.10 +Classifier: Programming Language :: Python :: 3.11 +Classifier: Programming Language :: Python :: 3.12 +Classifier: Programming Language :: Python :: 3.13 +Requires-Dist: deprecation (>=2.1.0,<3.0.0) +Requires-Dist: httpx[http2] (>=0.26,<0.29) +Requires-Dist: pydantic (>=1.9,<3.0) +Requires-Dist: strenum (>=0.4.9,<0.5.0) ; python_version < "3.11" +Project-URL: Documentation, https://postgrest-py.rtfd.io +Project-URL: Repository, https://github.com/supabase/postgrest-py +Description-Content-Type: text/markdown + +# postgrest-py + +[PostgREST](https://postgrest.org) client for Python. This library provides an "ORM-like" interface to PostgREST. + +## INSTALLATION + +### Requirements + +- Python >= 3.9 +- PostgreSQL >= 13 +- PostgREST >= 11 + +### Local PostgREST server + +If you want to use a local PostgREST server for development, you can use our preconfigured instance via Docker Compose. + +```sh +docker-compose up +``` + +Once Docker Compose started, PostgREST is accessible at <http://localhost:3000>. + +### Instructions + +#### With Poetry (recommended) + +```sh +poetry add postgrest +``` + +#### With Pip + +```sh +pip install postgrest +``` + +## USAGE + +### Getting started + +```py +import asyncio +from postgrest import AsyncPostgrestClient + +async def main(): + async with AsyncPostgrestClient("http://localhost:3000") as client: + r = await client.from_("countries").select("*").execute() + countries = r.data + +asyncio.run(main()) +``` + +### Create + +```py +await client.from_("countries").insert({ "name": "Việt Nam", "capital": "Hà Nội" }).execute() +``` + +### Read + +```py +r = await client.from_("countries").select("id", "name").execute() +countries = r.data +``` + +### Update + +```py +await client.from_("countries").update({"capital": "Hà Nội"}).eq("name", "Việt Nam").execute() +``` + +### Delete + +```py +await client.from_("countries").delete().eq("name", "Việt Nam").execute() +``` + +### General filters + +### Stored procedures (RPC) +```py +await client.rpc("foobar", {"arg1": "value1", "arg2": "value2"}).execute() +``` + +## DEVELOPMENT + +```sh +git clone https://github.com/supabase/postgrest-py.git +cd postgrest-py +poetry install +poetry run pre-commit install +``` + +### Testing + +```sh +poetry run pytest +``` + +## CHANGELOG + +Read more [here](https://github.com/supabase/postgrest-py/blob/main/CHANGELOG.md). + +## SPONSORS + +We are building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products don’t exist we build them and open source them ourselves. Thanks to these sponsors who are making the OSS ecosystem better for everyone. + +[](https://www.worklife.vc) +[](https://github.com/sponsors/supabase) + |