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
and
autodoc-pydantic
to manage the documentation for the client.
Source .rst files can be found in docs/source.
To generate/update documentation for the Tyba client, first make sure
your poetry environment includes the latest versions of all the dependency packages included in the docs. For example,
if generation-models
was recently updated and pushed to pypi, you should run poetry update
(or if you are concerned
about changing other packages, just poetry add generation-models==x.x.x
where x.x.x
is the latest version).
Then, 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.
This HTML documentation now 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 docs/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.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1f5fb5a2a35b941dc942fcdcb5c5d9550d01d26945de221bc54734ab177538e |
|
MD5 | 2d831f6b5a8b913c48d40eccd14c308f |
|
BLAKE2b-256 | 269837833c1c3abc604a550cb22f759294b580408606bdcee6aa3609c28cebe0 |