Skip to main content

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

Project description

postgrest-py

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

docker-compose up

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

Instructions

With Poetry (recommended)

poetry add postgrest

With Pip

pip install postgrest

USAGE

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 = r.data

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

Update

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

Delete

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()

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.

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.

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-1.0.2.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

postgrest-1.0.2-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

Details for the file postgrest-1.0.2.tar.gz.

File metadata

  • Download URL: postgrest-1.0.2.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for postgrest-1.0.2.tar.gz
Algorithm Hash digest
SHA256 42fa3a6e493d6c9e54afd907213608dcacb1f3d2f276ada19ef7b22bf64c78bd
MD5 55aaf33e94062030951ce4dd4e40e746
BLAKE2b-256 4aea9b0b5301c4a8fa360add83877f29f690b1b29d02a7d162aac528c7d385db

See more details on using hashes here.

Provenance

The following attestation bundles were made for postgrest-1.0.2.tar.gz:

Publisher: ci.yml on supabase/postgrest-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file postgrest-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: postgrest-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 22.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for postgrest-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d115c56d3bd2672029a3805e9c73c14aa6608343dc5228db18e0e5e6134a3c62
MD5 8b9dd80e089708e363cb970a344b6c58
BLAKE2b-256 52cea0655928584bba457ceda316e7a4fa02dfbb4366c6f393fe9473d0150597

See more details on using hashes here.

Provenance

The following attestation bundles were made for postgrest-1.0.2-py3-none-any.whl:

Publisher: ci.yml on supabase/postgrest-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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