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

Status: Unstable

INSTALLATION

Requirements

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

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

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.

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-py-0.3.2.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

postgrest_py-0.3.2-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file postgrest-py-0.3.2.tar.gz.

File metadata

  • Download URL: postgrest-py-0.3.2.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.8.5 Linux/5.7.15-1-MANJARO

File hashes

Hashes for postgrest-py-0.3.2.tar.gz
Algorithm Hash digest
SHA256 2bfde9db223bfaf4ff53811a5bebd531fed75190f5fb93423ec82ae9c23d7834
MD5 2809f1c50c18a0512fd6dba573906e0f
BLAKE2b-256 b2168c9bf0c592e86a47dcb2b3a3a0090e22031e633d18dbeaedbecfe61cbc92

See more details on using hashes here.

File details

Details for the file postgrest_py-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: postgrest_py-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.8.5 Linux/5.7.15-1-MANJARO

File hashes

Hashes for postgrest_py-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 61a2f153efbeb67d372659816bcd9c306c8b26a0e17c50d374e412170118bd02
MD5 c5c800cb1fe43a86e3872da84364aeb2
BLAKE2b-256 6acbbf1d58d848b988fc345fd9cb3bfc4afee308ea184b4b7bbf6db7c463cbf8

See more details on using hashes here.

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