postgrest-py

PostgREST client for Python. This library provides an ORM interface to PostgREST.

Status: Unstable

INSTALLATION

Requirements

• Python >= 3.7
• PostgreSQL >= 12
• PostgREST >= 7

Local PostgREST server

If you want to use a local PostgREST server for development, you can use our preconfigured instance via Docker Compose.

docker-compose up

Once Docker Compose started, PostgREST is accessible at http://localhost:3000.

Instructions

With Poetry (recommended)

$ poetry add postgrest-py

With Pip

$ pip install postgrest-py

USAGE

Getting started

import asyncio
from postgrest_py import PostgrestClient

async def main():
    async with PostgrestClient("http://localhost:3000") as client:
        r = await client.from_("countries").select("*").execute()
        countries = r.json()

asyncio.run(main())

Create

await client.from_("countries").insert({ "name": "Việt Nam", "capital": "Hà Nội" }).execute()

Read

r = await client.from_("countries").select("id", "name").execute()
countries = r.json()

Update

await client.from_("countries").eq("name", "Việt Nam").update({"capital": "Hà Nội"}).execute()

Delete

await client.from_("countries").eq("name", "Việt Nam").delete().execute()

General filters

Stored procedures (RPC)

DEVELOPMENT

$ git clone https://github.com/supabase/postgrest-py.git
$ cd postgrest-py
$ poetry install
$ poetry run pre-commit install

Testing

$ poetry run pytest

CHANGELOG

Read more here.

TODO

Read more here.

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.