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

Uploaded Source

Built Distribution

postgrest_py-0.5.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: postgrest-py-0.5.0.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.6 Linux/5.10.62-1-MANJARO

File hashes

Hashes for postgrest-py-0.5.0.tar.gz
Algorithm Hash digest
SHA256 fe251d7a27539fe01afa5cb266c2f5c04bb25115e0b19d424f33861a4e31fd89
MD5 bec90b9522f19e34941f42cd56c00eb5
BLAKE2b-256 239b58aea163cdeba988db49045cbc355c85351de72cca26c3170dc20dedc2b4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: postgrest_py-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.9.6 Linux/5.10.62-1-MANJARO

File hashes

Hashes for postgrest_py-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d0741af1de0da54846ec5356ca3145d019ef2996d46cd5015737b415109cce2b
MD5 a952eab7e614187c798f89b9909dc557
BLAKE2b-256 e0ecd5b3d786da57f68075c3e219dba6887e5d5dc0c57957f83e0596d8901c45

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