A python client for interacting with PostgREST APIs.
Project description
Pypgrest
A python client for interacting with PostgREST APIs.
Installation
$ pip install pypgrest
Usage
>>> from pypgrest import Postgrest
>>> pgrest = Postgrest("https://api.tacos.com", auth="secretsalsa")
'''
See postgrest docs for support query params
'''
>>> params = {
"select" : "name,tortilla,cost",
"tortilla" : "is.corn",
"limit" : 100
}
'''
Supported methods are select, insert, update, and upsert
'''
>>> pgrest.select(params=params)
[{ "name" : "al pastor", "tortilla" : "corn", "cost" : "2.01" }, ... ]
>>> payload = [{ "id" : 23, "cost" : "2.25" }, { "id" : 26, "cost" : "1.25" }]
>>> pgrest.upsert(payload)
[{ "id" : 23, "cost" : "2.25", "name" : "al pastor", ... }, ... ]
'''
You can inspect the `Requests` response object like so:
'''
>>> pgrest.res.status_code
201
'''
If results are paginated the client will continue to request until the specified
limit (default 1000) is met.
'''
>>> pgrest.select(params={"limit" : 1000})
License
As a work of the City of Austin, this project is in the public domain within the United States.
Additionally, we waive copyright and related rights of the work worldwide through the CC0 1.0 Universal public domain dedication.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for pypgrest-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 357ad7b7cf11a462ee23be3eb83c26da8a22abaa68e721d0ef7fd42820ace0e2 |
|
MD5 | 626964a6b155d9ef08f9d2b4d83b2dcb |
|
BLAKE2b-256 | 4dd17359e0e1258175a0254bafe1c6cb5d6e103c89cbe2879c948cc2bb4eed9b |