Skip to main content

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

Project description


License: MIT CI Python Version Codecov Last commit GitHub commit activity Github Stars Github Forks Github Watchers GitHub contributors

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

Status: Unstable



  • 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.


With Poetry (recommended)

poetry add postgrest

With Pip

pip install postgrest


Getting started

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 =


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


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


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


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

General filters

Stored procedures (RPC)

await client.rpc("foobar", {"arg1": "value1", "arg2": "value2"}).execute()


git clone
cd postgrest-py
poetry install
poetry run pre-commit install


poetry run pytest


Read more here.


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.

Worklife VC New Sponsor

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

postgrest-0.13.0.tar.gz (13.9 kB view hashes)

Uploaded source

Built Distribution

postgrest-0.13.0-py3-none-any.whl (19.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page