A Python API client for the Tyba Public API
Project description
Tyba API Client
Examples
For examples see https://github.com/Tyba-Energy/tyba-client-notebooks. The script examples in tyba-python-client/examples will be deprecated eventually.
Development
Docs
We use sphinx
to manage the documentation for the client.
Source .rst files can be found in docs/source. We use the
intersphinx
extension to manage links
between the client docs and the docs of generation_models
(the model
schema for the client). Make sure you understand how these links are defined based on the intersphinx_mapping
variable in docs/source/conf.py to avoid any gotchas.
To generate/update documentation for the Tyba client, cd
into the docs directory and run the makefile that generates
the HTML documentation
# Assuming you are already in the tyba-python-client directory
$ cd docs
$ poetry run make html
The HTML documentation can be found in docs/build/html.
Once it's been reviewed, this HTML documentation needs to be uploaded to s3, so it can be served at https://docs.tybaenergy.com/api/. We have a python script to do this
poetry run python upload_to_s3.py
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 tyba_client-0.3.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a51b158cd535a3378570612a715f87cd570c57bf5aeedf0f19aad4b0d10fe6d8 |
|
MD5 | b5e41b00d5f143b189f7d4af36a88d5c |
|
BLAKE2b-256 | ffd1c2ec057d3b3bdb308756d65cf40c9d1799b585548441f528c6b711581925 |