Python SDK for intercating with Okareo Cloud APIs
Project description
Okareo Python SDK
PyPI: https://pypi-hypernode.com/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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file okareo-0.0.17.tar.gz.
File metadata
- Download URL: okareo-0.0.17.tar.gz
- Upload date:
- Size: 20.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.10.13 Linux/6.2.0-1014-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 765247e623941172dc72581d22ab2028cccce987f70f8c912cacfb4f0eebc3ad |
|
| MD5 | f6a5ac99c14b042dd65b2154ea4c344b |
|
| BLAKE2b-256 | 9c5d8046777ac8ed10ee0c4d831e3afb4d222a09601a14da4ce52c699e446a91 |
File details
Details for the file okareo-0.0.17-py3-none-any.whl.
File metadata
- Download URL: okareo-0.0.17-py3-none-any.whl
- Upload date:
- Size: 56.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.6.1 CPython/3.10.13 Linux/6.2.0-1014-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6a290dac5c43f9791f5db607e403bc0325cc2db4fd8c410415cfac4d6f8fb0b2 |
|
| MD5 | 5a649652096b9c888267239858f87d1a |
|
| BLAKE2b-256 | 3a62aef7a6ab5c38271c3cc9f77dc6c863b733fafb6f8778b00e1610af8498b5 |
