ercot-api 0.1.0__py3-none-any.whl

ercot_api/__init__.py

@@ -0,0 +1,69 @@
+"""ercot_api: thin urllib client for the ERCOT Public API.
+
+Credentials come from registering on the ERCOT Public API Portal
+(https://apiexplorer.ercot.com): you get a subscription key, and a bearer token is
+obtained from the ERCOT B2C sign-in flow for your registered account. Both are passed
+in as plain strings; this package never stores them.
+"""
+from __future__ import annotations
+
+import argparse
+import json
+import urllib.parse
+import urllib.request
+
+__version__ = "0.1.0"
+__all__ = ["ErcotClient", "BASE_URL", "main", "__version__"]
+
+BASE_URL = "https://api.ercot.com/api/public-reports"
+
+
+class ErcotClient:
+    """Call ERCOT public report endpoints, e.g. client.get("np6-905-cd/spp_node_zone_hub")."""
+
+    def __init__(self, subscription_key: str, bearer: str, base_url: str = BASE_URL, timeout: float = 30.0,
+                 opener=None):
+        self.subscription_key = subscription_key
+        self.bearer = bearer
+        self.base_url = base_url.rstrip("/")
+        self.timeout = timeout
+        self._open = opener or urllib.request.urlopen
+
+    def build_request(self, report_id: str, **params) -> urllib.request.Request:
+        url = f"{self.base_url}/{report_id.strip('/')}"
+        clean = {k: v for k, v in params.items() if v is not None}
+        if clean:
+            url += "?" + urllib.parse.urlencode(clean)
+        return urllib.request.Request(url, headers={
+            "Ocp-Apim-Subscription-Key": self.subscription_key,
+            "Authorization": f"Bearer {self.bearer}",
+            "Accept": "application/json",
+        })
+
+    def get(self, report_id: str, **params):
+        req = self.build_request(report_id, **params)
+        with self._open(req, timeout=self.timeout) as resp:
+            return json.loads(resp.read().decode("utf-8"))
+
+
+def main(argv=None) -> int:
+    p = argparse.ArgumentParser(prog="ercot-api", description=__doc__,
+                                formatter_class=argparse.RawDescriptionHelpFormatter)
+    p.add_argument("--version", action="version", version=__version__)
+    p.add_argument("report_id", nargs="?", help="e.g. np6-905-cd/spp_node_zone_hub")
+    p.add_argument("--key", help="Ocp-Apim-Subscription-Key from the ERCOT Public API Portal")
+    p.add_argument("--bearer", help="bearer token from ERCOT sign-in")
+    p.add_argument("--param", action="append", default=[], metavar="K=V", help="query parameter")
+    a = p.parse_args(argv)
+    if not a.report_id:
+        p.print_help()
+        return 0
+    if not (a.key and a.bearer):
+        p.error("--key and --bearer are required (register at https://apiexplorer.ercot.com)")
+    params = dict(kv.split("=", 1) for kv in a.param)
+    print(json.dumps(ErcotClient(a.key, a.bearer).get(a.report_id, **params), indent=2))
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

ercot_api/__main__.py

@@ -0,0 +1,3 @@
+from . import main
+
+raise SystemExit(main())

ercot_api-0.1.0.dist-info/METADATA

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: ercot-api
+Version: 0.1.0
+Summary: Minimal client skeleton for the ERCOT Public API (api.ercot.com/api/public-reports)
+Author-email: BitSquad LLC <admin@megawattland.com>
+License: MIT
+Project-URL: Homepage, https://megawattland.com
+Project-URL: Repository, https://github.com/chutch62416-netizen/vault
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# ercot-api
+
+Minimal client skeleton for the ERCOT Public API (api.ercot.com/api/public-reports)
+
+## Credentials
+
+Register at the ERCOT Public API Portal (https://apiexplorer.ercot.com). Registration gives you
+an `Ocp-Apim-Subscription-Key`; the bearer token comes from ERCOT's sign-in flow for that account.
+This package does not store or obtain credentials for you.
+
+## Usage
+
+```python
+from ercot_api import ErcotClient
+c = ErcotClient(subscription_key="...", bearer="...")
+c.get("np6-905-cd/spp_node_zone_hub", deliveryDateFrom="2026-01-01", size=100)
+```
+
+```
+ercot-api --help
+ercot-api np6-905-cd/spp_node_zone_hub --key KEY --bearer TOKEN --param size=10
+```
+
+Unofficial; not affiliated with ERCOT.
+
+Maintained by [BitSquad LLC / MegawattLand](https://megawattland.com). MIT license. Source: https://github.com/chutch62416-netizen/vault

ercot_api-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+ercot_api/__init__.py,sha256=WghLayH1KMhlAFciH7acPlMB3PWwzZru4r6rt_q5Gk0,2821
+ercot_api/__main__.py,sha256=BHLi_-4Bx1gsZn-z6x7wECPn1YTxdc74y0deRea9FzY,45
+ercot_api-0.1.0.dist-info/licenses/LICENSE,sha256=PKnyP0njONZraEkwKoS7B021snnKAl2lI3AenCo-RVM,1069
+ercot_api-0.1.0.dist-info/METADATA,sha256=GJu1E2Vjb8wOX8Ai10Z-U1tzvRFgYZBIF-Q4ONrPxyY,1471
+ercot_api-0.1.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+ercot_api-0.1.0.dist-info/entry_points.txt,sha256=KxSJMPeV3s3ks3ropVL9YYOXH-NxfwId80UhVBl6Mzg,45
+ercot_api-0.1.0.dist-info/top_level.txt,sha256=cJa03q3d55L1Qca4_2Ph1kdCXFHcWoDhMZ7Qwl9chto,10
+ercot_api-0.1.0.dist-info/RECORD,,

ercot_api-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ercot_api-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ercot-api = ercot_api:main

ercot_api-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 BitSquad LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ercot_api-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+ercot_api