okareo 0.0.15

Python SDK for intercating with Okareo Cloud APIs

Okareo Python SDK

---

PyPI: https://pypi.org/project/okareo/

---

Python SDK for interacting with Okareo Cloud APIs

Installation

pip install okareo

Get Started Example

Please see and run this notebook: https://github.com/okareo-ai/okareo-python-sdk/blob/main/examples/example.ipynb

Development

• Clone this repository
• Requirements:
  • Poetry
  • Python 3.9+
• Create a virtual environment and install the dependencies

poetry install

• Activate the virtual environment

poetry shell

Update/regenerate client api code

Our client code is auto-generated from the OpenAPI spec of the Okareo API. In order to update the code in repo install openapi-python-generator.

pip install openapi-python-generator

Then, updating the client code to the latest production server spec is as easy as running.

make openapi/update

or, you you want to use your development api server spc, you can use it as a source with

OPENAPI_SPEC="http://localhost:8000/openapi.json" make openapi/update

If you have the openapi.json already in the project dir you can simply run

make openapi/generate

to only trigger code generation, without fetching the OpenAPI spec json.

Testing

pytest

Documentation

The documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published as a Github project page automatically as part each release.

Releasing

Trigger the Draft release workflow (press Run workflow). This will update the changelog & version and create a GitHub release which is in Draft state.

Find the draft release from the GitHub releases and publish it. When a release is published, it'll trigger release workflow which creates PyPI release and deploys updated documentation.

Pre-commit

Pre-commit hooks run all the auto-formatters (e.g. black, isort), linters (e.g. mypy, flake8), and other quality checks to make sure the changeset is in good shape before a commit/push happens.

You can install the hooks with (runs for each commit):

pre-commit install

Or if you want them to run only for each push:

pre-commit install -t pre-push

Or if you want e.g. want to run all checks manually for all files:

pre-commit run --all-files

---

All rights reserved for Okareo Inc