cosmetics

Author: vaphes

.github/workflows/python-versions.yml .github/workflows/tests.yml.github/workflows/python-versions.yml renamed to .github/workflows/tests.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Python 3.7-3.10
+name: Tests
 
 on:
   push:

README.md

@@ -1,17 +1,46 @@
 # PocketBase Python SDK
 
-[![Python 3.7-3.10](https://github.com/vaphes/pocketbase/actions/workflows/python-versions.yml/badge.svg)](https://github.com/vaphes/pocketbase/actions/workflows/python-versions.yml)
+[![Tests](https://github.com/vaphes/pocketbase/actions/workflows/tests.yml/badge.svg)](https://github.com/vaphes/pocketbase/actions/workflows/tests.yml)
 
 Python client SDK for the <a href="https://pocketbase.io/">PocketBase</a> backend.
 
 This is in early development, and at first is just a translation of <a href="https://github.com/pocketbase/js-sdk">the javascript lib</a> using <a href="https://github.com/encode/httpx/">HTTPX</a>.
 
 ---
 
+## Installation
+
 Install PocketBase using pip:
 
 ```shell
 $ pip install pocketbase
 ```
 
+## Usage
+
+The rule of thumb here is just to use it as you would <a href="https://github.com/pocketbase/js-sdk">the javascript lib</a>, but in a pythonic way of course!
+
+```python
+from pocketbase import Client
+
+client = Client('http://127.0.0.1:8090')
+
+...
+
+# list and filter "example" collection records
+result = client.records.get_list(
+    "example", 1, 20, {"filter": 'status = true && created > "2022-08-01 10:00:00"'}
+)
+
+# authenticate as regular user
+user_data = client.users.auth_via_email("[email protected]", "123456")
+
+# or as admin
+admin_data = client.admins.auth_via_email("[email protected]", "123456")
+
+# and much more...
+```
+> More detailed API docs and copy-paste examples could be found in the [API documentation for each service](https://pocketbase.io/docs/api-authentication). Just remember to 'pythonize it' 🙃.
+
+
 <p align="center"><i>The PocketBase Python SDK is <a href="https://github.com/vaphes/pocketbase/blob/master/LICENCE.txt">MIT licensed</a> code.</p>

pocketbase/__init__.py

@@ -1,6 +1,6 @@
 __title__ = "pocketbase"
 __description__ = "PocketBase client SDK for python."
-__version__ = "0.2.0"
+__version__ = "0.2.1"
 
 
 from .client import Client, ClientResponseError

pocketbase/client.py

@@ -66,7 +66,7 @@ def send(self, path: str, req_config: dict[str:Any]) -> Any:
         config.update(req_config)
         # check if Authorization header can be added
         if self.auth_store.token and (
-            not "headers" in config or "Authorization" not in config["headers"]
+            "headers" not in config or "Authorization" not in config["headers"]
         ):
             auth_type = "Admin"
             if hasattr(self.auth_store.model, "verified"):

pocketbase/stores/local_auth_store.py

@@ -28,14 +28,14 @@ def __init__(
     @property
     def token(self) -> str:
         data = self._storage_get(self.complete_filepath)
-        if not data or not "token" in data:
+        if not data or "token" not in data:
             return None
         return data["token"]
 
     @property
     def model(self) -> User | Admin | None:
         data = self._storage_get(self.complete_filepath)
-        if not data or not "model" in data:
+        if not data or "model" not in data:
             return None
         return data["model"]