tyba-client 0.4.4__tar.gz → 0.4.6__tar.gz

tyba_client-0.4.6/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: tyba-client
+Version: 0.4.6
+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) ; python_version < "3.9"
+Requires-Dist: pandas (>=2.0.0,<3.0.0) ; python_version >= "3.9"
+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.6/README.md

@@ -0,0 +1,33 @@
+# 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.4 → tyba_client-0.4.6}/pyproject.toml

@@ -1,10 +1,10 @@
 [tool.poetry]
 name = "tyba-client"
-version = "0.4.4"
+version = "0.4.6"
 description = "A Python API client for the Tyba Public API"
 authors = ["Tyler Nisonoff <tyler@tybaenergy.com>"]
 license = "MIT"
-readme = "PYPI_README.md"
+readme = "README.md"
 include = [
     "LICENSE",
 ]
@@ -14,7 +14,10 @@ python = "^3.8"
 requests = "^2.25.1"
 dataclasses-json = "^0.6.4"
 marshmallow = "^3.12.1"
-pandas = "^1.3.2"
+pandas = [
+    { version = "^1.3.2", python = "<3.9" },
+    { version = "^2.0.0", python = ">=3.9" }
+]
 tyba-financial-model = "^0"
 structlog = "^24.1.0"
 generation-models = "^0"

{tyba_client-0.4.4 → tyba_client-0.4.6}/tyba_client/client.py

@@ -11,6 +11,8 @@ import time
 from structlog import get_logger
 from typing import Callable
 
+from tyba_client.operations import Operations
+
 logger = get_logger()
 
 
@@ -114,6 +116,7 @@ class Client(object):
         self.host = host
         self.services = Services(self)
         self.forecast = Forecast(self)
+        self.operations = Operations(self)
         self.request_args = {} if request_args is None else request_args
 
     def _auth_header(self):

tyba_client-0.4.6/tyba_client/operations.py

@@ -0,0 +1,60 @@
+from datetime import date
+
+
+class Operations(object):
+    def __init__(self, client):
+        self.client = client
+
+    def get(self, route, params=None):
+        response = self.client.get(f"operations/{route}", params=params)
+        response.raise_for_status()
+        return response.text
+
+    def performance_report(
+            self,
+            start_date: date,
+            end_date: date,
+            asset_name: str,
+    ):
+        return self.get(
+            "internal_api/performance_report",
+            params={
+                "start_date": start_date,
+                "end_date": end_date,
+                "asset_name": asset_name,
+            },
+        )
+
+    def da_snapshot(
+            self,
+            start_date: date,
+            end_date: date,
+            asset_name: str,
+    ):
+        return self.get(
+            "internal_api/da_snapshot",
+            params={
+                "start_date": start_date,
+                "end_date": end_date,
+                "asset_name": asset_name,
+            },
+        )
+
+    def telemetry(
+            self,
+            start_date: date,
+            end_date: date,
+            asset_name: str,
+            interval_mins: int,
+            metrics: list[str]
+    ):
+        return self.get(
+            "internal_api/telemetry",
+            params={
+                "start_date": start_date,
+                "end_date": end_date,
+                "asset_name": asset_name,
+                "interval_mins": interval_mins,
+                "metrics": metrics,
+            },
+        )

tyba_client-0.4.4/PKG-INFO

@@ -1,33 +0,0 @@
-Metadata-Version: 2.1
-Name: tyba-client
-Version: 0.4.4
-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="tyba-logo.svg" width="300">
-</h1><br>
-
-
-Python client to Tyba's project simulation API.
-
-__Documentation:__ https://docs.tybaenergy.com/api
-

tyba_client-0.4.4/PYPI_README.md

@@ -1,8 +0,0 @@
-<h1 align="center">
-<img src="tyba-logo.svg" width="300">
-</h1><br>
-
-
-Python client to Tyba's project simulation API.
-
-__Documentation:__ https://docs.tybaenergy.com/api