From a690d451ab5b29fecf3a414acc00fa6031accb86 Mon Sep 17 00:00:00 2001 From: Paulo Coutinho Date: Fri, 10 Feb 2023 15:19:17 -0300 Subject: [PATCH] fix readme (#23) * fix readme * fix version * fix imports --- README.md | 40 +++++++++++++++++++++++++++++++++++++--- pocketbase/__init__.py | 4 ++-- pyproject.toml | 2 +- tests/test_utils.py | 2 +- 4 files changed, 41 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2f4afdc..820e0a4 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,10 @@ This is in early development, and at first is just a translation of 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' 🙃. +## Development -

The PocketBase Python SDK is MIT licensed code.

+These are the requirements for local development: + +* Python 3.7+ +* Poetry (https://python-poetry.org/) + +You can install locally: + +```shell +poetry install +``` + +Or can build and generate a package: + +```shell +poetry build +``` + +But if you are using only PIP, use this command: + +```shell +python3 -m pip install -e . +``` + +## Tests + +To execute the tests use this command: + +``` +poetry run pytest +``` + +## License + +The PocketBase Python SDK is MIT licensed code. diff --git a/pocketbase/__init__.py b/pocketbase/__init__.py index b35f624..e1313a3 100644 --- a/pocketbase/__init__.py +++ b/pocketbase/__init__.py @@ -1,9 +1,9 @@ __title__ = "pocketbase" __description__ = "PocketBase client SDK for python." -__version__ = "0.3.0" +__version__ = "0.8.0" -from .client import Client, ClientResponseError +from .client import Client class PocketBase(Client): diff --git a/pyproject.toml b/pyproject.toml index b9d9b7b..59f3d76 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -29,7 +29,7 @@ dynamic = ["readme", "version"] [tool.poetry] name = "pocketbase" -version = "0.3.0" +version = "0.8.0" description = "PocketBase SDK for python." authors = ["Vithor Jaeger "] readme = "README.md" diff --git a/tests/test_utils.py b/tests/test_utils.py index 6414787..ac38a09 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -5,7 +5,7 @@ from pocketbase.utils import camel_to_snake, to_datetime def test_version(): - assert __version__ == "0.3.0" + assert __version__ == "0.8.0" def test_utils():