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

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

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

postgrest-2.27.3-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: postgrest-2.27.3.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.2

File hashes

Hashes for postgrest-2.27.3.tar.gz
Algorithm Hash digest
SHA256 c2e2679addfc8eaab23197bad7ddaee6cbb4cbe8c483ebd2d2e5219543037cc3
MD5 eed5df01d1772c7d46e1e629f7ec4c98
BLAKE2b-256 b46f1985be8afb32931e9b537ea0a6fedd103ea9dc6b0ac91b6f32702435564a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: postgrest-2.27.3-py3-none-any.whl
  • Upload date:
  • Size: 22.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.2

File hashes

Hashes for postgrest-2.27.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ed79123af7127edd78d538bfe8351d277e45b1a36994a4dbf57ae27dde87a7b7
MD5 9e5b21c8d93511fb521f0a492e6e1e48
BLAKE2b-256 14ec7122631cbd28b12b1a61b472ca3e1686ac557c6a478fdeca0f33419e87da

See more details on using hashes here.

Supported by

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