tyba-client 0.4.3__tar.gz → 0.4.5__tar.gz

tyba_client-0.4.5/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.1
+Name: tyba-client
+Version: 0.4.5
+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
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: dataclasses-json (>=0.6.4,<0.7.0)
+Requires-Dist: generation-models (>=0,<1)
+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 (>=24.1.0,<25.0.0)
+Requires-Dist: tyba-financial-model (>=0,<1)
+Description-Content-Type: text/markdown
+
+<h1 align="center">
+<img src="https://cdn.prod.website-files.com/669594441bac4d6528273301/669594441bac4d6528273329_Group%20180.svg" alt="TYBA" width="300">
+</h1><br>
+
+
+Python client to Tyba's project simulation API.
+
+__Documentation:__ https://docs.tybaenergy.com/api
+

tyba_client-0.4.5/PYPI_README.md

@@ -0,0 +1,8 @@
+<h1 align="center">
+<img src="https://cdn.prod.website-files.com/669594441bac4d6528273301/669594441bac4d6528273329_Group%20180.svg" alt="TYBA" width="300">
+</h1><br>
+
+
+Python client to Tyba's project simulation API.
+
+__Documentation:__ https://docs.tybaenergy.com/api

{tyba_client-0.4.3 → tyba_client-0.4.5}/pyproject.toml

@@ -1,10 +1,10 @@
 [tool.poetry]
 name = "tyba-client"
-version = "0.4.3"
+version = "0.4.5"
 description = "A Python API client for the Tyba Public API"
 authors = ["Tyler Nisonoff <tyler@tybaenergy.com>"]
 license = "MIT"
-readme = "README.md"
+readme = "PYPI_README.md"
 include = [
     "LICENSE",
 ]

{tyba_client-0.4.3 → tyba_client-0.4.5}/tyba_client/models.py

@@ -6,10 +6,16 @@ import pandas as pd
 import typing as t
 from .io import read_pvsyst_file
 from .solar_resource import psm_column_map
+from warnings import warn
 
 from tyba_client.utils import string_enum
 
 
+warn("""tyba_client.models is deprecated in favor of using generation_models. Tyba will cease to support 
+tyba_client.models come 1/1/2025. See https://docs.tybaenergy.com/api/index.html or reach out to us for
+help migrating.""", FutureWarning)
+
+
 class ValidationError(ValueError):
     pass
 

tyba_client-0.4.3/PKG-INFO

@@ -1,58 +0,0 @@
-Metadata-Version: 2.1
-Name: tyba-client
-Version: 0.4.3
-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
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: dataclasses-json (>=0.6.4,<0.7.0)
-Requires-Dist: generation-models (>=0,<1)
-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 (>=24.1.0,<25.0.0)
-Requires-Dist: tyba-financial-model (>=0,<1)
-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) to manage the documentation for the client.
-Source .rst files can be found in docs/source. We use the
-[`intersphinx`](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#) extension to manage links
-between the client docs and the docs of [`generation_models`](https://github.com/Tyba-Energy/generation/) (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
-```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.
-
-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/](https://docs.tybaenergy.com/api/). We have a python script to do
-this
-```bash
-poetry run python upload_to_s3.py
-```
-
-
-
-

tyba_client-0.4.3/README.md

@@ -1,33 +0,0 @@
-# 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) to manage the documentation for the client.
-Source .rst files can be found in docs/source. We use the
-[`intersphinx`](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#) extension to manage links
-between the client docs and the docs of [`generation_models`](https://github.com/Tyba-Energy/generation/) (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
-```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.
-
-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/](https://docs.tybaenergy.com/api/). We have a python script to do
-this
-```bash
-poetry run python upload_to_s3.py
-```
-
-
-