Namespace change (#114)

* docs: add rtd config

* chore: move to the postgrest namespace

* chore: move constants to its own file

* chore: pass headers/params down builders

We were earlier modifying session.headers/session.params for every
query. Instead of this we follow what postgrest-js does and add
headers and params as arguments to the query builders, and pass them
down the chain of builders, and finally pass it to the execute method.

* docs: add examples

* fix: order of filters in examples

* docs: add example for closing the client

Author: anand2312

.readthedocs.yaml

@@ -0,0 +1,14 @@
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+python:
+   install:
+   - requirements: docs/requirements.txt
+
+
+   - method: pip
+     path: .

Makefile

@@ -25,4 +25,4 @@ clean_infra:
 run_tests: tests
 
 build_sync:
-	poetry run unasync postgrest_py tests
+	poetry run unasync postgrest tests

README.md

@@ -54,7 +54,7 @@ pip install postgrest-py
 
 ```py
 import asyncio
-from postgrest_py import AsyncPostgrestClient
+from postgrest import AsyncPostgrestClient
 
 async def main():
     async with AsyncPostgrestClient("http://localhost:3000") as client:
@@ -74,24 +74,27 @@ await client.from_("countries").insert({ "name": "Việt Nam", "capital": "Hà N
 
 ```py
 r = await client.from_("countries").select("id", "name").execute()
-countries = r.json()
+countries = r.data
 ```
 
 ### Update
 
 ```py
-await client.from_("countries").eq("name", "Việt Nam").update({"capital": "Hà Nội"}).execute()
+await client.from_("countries").update({"capital": "Hà Nội"}).eq("name", "Việt Nam").execute()
 ```
 
 ### Delete
 
 ```py
-await client.from_("countries").eq("name", "Việt Nam").delete().execute()
+await client.from_("countries").delete().eq("name", "Việt Nam").execute()
 ```
 
 ### General filters
 
 ### Stored procedures (RPC)
+```py
+await client.rpc("foobar", {"arg1": "value1", "arg2": "value2"}).execute()
+```
 
 ## DEVELOPMENT
 

docs/api/client.rst

@@ -5,10 +5,10 @@ To run any queries, the first step is to construct a client.
 
 The library offers both synchronous and asynchronous clients.
 
-.. autoclass:: postgrest_py.AsyncPostgrestClient
+.. autoclass:: postgrest.AsyncPostgrestClient
     :members:
     :inherited-members:
 
-.. autoclass:: postgrest_py.SyncPostgrestClient
+.. autoclass:: postgrest.SyncPostgrestClient
     :members:
     :inherited-members:

docs/api/exceptions.rst

@@ -1,5 +1,5 @@
 Exceptions
 ==========
 
-.. autoexception:: postgrest_py.APIError
+.. autoexception:: postgrest.APIError
     :members:

docs/api/filters.rst

@@ -18,10 +18,14 @@ filter data during queries.
     All the filter methods return a modified instance of the filter builder, allowing fluent chaining of filters.
 
 
-.. autoclass:: postgrest_py.AsyncFilterRequestBuilder
+.. autoclass:: postgrest.AsyncFilterRequestBuilder
     :members:
+    :undoc-members:
     :inherited-members:
+    :member-order: bysource
 
-.. autoclass:: postgrest_py.SyncFilterRequestBuilder
+.. autoclass:: postgrest.SyncFilterRequestBuilder
     :members:
+    :undoc-members:
     :inherited-members:
+    :member-order: bysource

docs/api/request_builders.rst

@@ -8,26 +8,26 @@ Request Builders
 .. warning::
     These classes are not meant to be constructed by the user.
 
-.. autoclass:: postgrest_py.AsyncRequestBuilder
+.. autoclass:: postgrest.AsyncRequestBuilder
     :members:
     :inherited-members:
 
-.. autoclass:: postgrest_py.AsyncSelectRequestBuilder
+.. autoclass:: postgrest.AsyncSelectRequestBuilder
     :members:
     :inherited-members:
 
-.. autoclass:: postgrest_py.AsyncQueryRequestBuilder
+.. autoclass:: postgrest.AsyncQueryRequestBuilder
     :members:
     :inherited-members:
 
-.. autoclass:: postgrest_py.SyncRequestBuilder
+.. autoclass:: postgrest.SyncRequestBuilder
     :members:
     :inherited-members:
 
-.. autoclass:: postgrest_py.SyncSelectRequestBuilder
+.. autoclass:: postgrest.SyncSelectRequestBuilder
     :members:
     :inherited-members:
 
-.. autoclass:: postgrest_py.SyncQueryRequestBuilder
+.. autoclass:: postgrest.SyncQueryRequestBuilder
     :members:
     :inherited-members:

docs/api/responses.rst

@@ -1,7 +1,7 @@
 Responses
 =========
 
-Once a query is run, the postgrest_py parses the server's response into an APIResponse object.
+Once a query is run, the library parses the server's response into an APIResponse object.
 
-.. autoclass:: postgrest_py.APIResponse
+.. autoclass:: postgrest.APIResponse
     :members:

docs/api/types.rst

@@ -3,14 +3,14 @@ Types
 
 Some type aliases and enums used in the library.
 
-.. autoclass:: postgrest_py.types.CountMethod
+.. autoclass:: postgrest.types.CountMethod
     :members:
 
-.. autoclass:: postgrest_py.types.Filters
+.. autoclass:: postgrest.types.Filters
     :members:
 
-.. autoclass:: postgrest_py.types.RequestMethod
+.. autoclass:: postgrest.types.RequestMethod
     :members:
 
-.. autoclass:: postgrest_py.types.ReturnMethod
+.. autoclass:: postgrest.types.ReturnMethod
     :members:

docs/conf.py

@@ -16,10 +16,10 @@
 
 
 # -- Project information -----------------------------------------------------
-import postgrest_py
+import postgrest
 
 project = "postgrest-py"
-version = postgrest_py.__version__
+version = postgrest.__version__
 release = version
 copyright = (
     "2022, Anand Krishna, Daniel Reinón García, Joel Lee, Leynier Gutiérrez González"
@@ -64,4 +64,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+html_static_path = []