SDK for interacting with the Comotion APIs
Project description
comotion-sdk
comotion-sdk is the python SDK for interacting with the Comotion APIs. Initial support is limited to Dash, but may expand in future.
Documentation
Documentation for this module can be found here.
Contributing
In order to contribute to this project, fork this repo and submit a pull request to this project
In order to set up a local environment, pull this repo and install.
pipenv
is used to manage dependencies on this project. in order to use it, ensure that pipenv is installed.
pip install --upgrade pip
pip install pipenv
And then enter the virtual environment for this project that will automatically ensure all dependencies are available
pipenv shell
pipenv install -e .
Building docs
Run the following from the docs directly. Ensure to watch out for warnings.
make html
Rerunning code generator
We use OpenApi generator to generate the python.
The requirements for this are a swagger file that can be gotten from WHERE?
The latest swagger file is stored in openapi_generator/comodash_api_swagger.json
Download latest jar of OpenAPI Generator
java -jar \ ./openapi_generator/openapi-generator-cli-5.2.1.jar generate \ -i ./openapi_generator/comodash_api_swagger.yaml\ -g python \ --package-name comodash_api_client_lowlevel \ --api-package comodash_api \ --additional-properties generateSourceCodeOnly=True,library=asyncio \ -o ./src/
Project details
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
Hashes for comotion_sdk-0.0.20-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ac62dde2f46289edfb5ddd06b1e7b1ecb7412dc9a4f4739f44acdfabd29ca9f |
|
MD5 | 4fcf550564d221193292c2f9a846dc63 |
|
BLAKE2b-256 | 01ab2246b1e67e60563f6add68d47249e8c850bb5581ace754d585401e2c51a3 |