Metadata-Version: 2.1
Name: tyba-client
Version: 0.3.0
Summary: A Python API client for the Tyba Public API
License: MIT
Author: Tyler Nisonoff
Author-email: tyler@tybaenergy.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: dataclasses-json (>=0.5.4,<0.6.0)
Requires-Dist: generation-models (>=0.3.0,<0.4.0)
Requires-Dist: marshmallow (>=3.12.1,<4.0.0)
Requires-Dist: pandas (>=1.3.2,<2.0.0)
Requires-Dist: requests (>=2.25.1,<3.0.0)
Requires-Dist: structlog (>=23.1.0,<24.0.0)
Requires-Dist: tyba-financial-model (>=0.1.0,<0.2.0)
Description-Content-Type: text/markdown

# Tyba API Client

## Examples
For examples see [https://github.com/Tyba-Energy/tyba-client-notebooks](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`](https://github.com/sphinx-doc/sphinx) and
[`autodoc-pydantic`](https://github.com/mansenfranzen/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
```bash
# 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/](https://docs.tybaenergy.com/api/). We have a python script to do this
```bash
poetry run python docs/upload_to_s3.py
```




