eiax 0.1.0__tar.gz

eiax-0.1.0/.env.example

@@ -0,0 +1,5 @@
+EIA_API_KEY=
+# Optional overrides (pipelines set these as env vars; .env is local dev only)
+# EIA_CACHE_DIR=~/.cache/eiax
+# EIA_RATE_LIMIT=5.0
+# EIA_CACHE_ENABLED=true

eiax-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - run: uv sync --all-extras
+      - run: uv run ruff check src tests
+      - run: uv run ruff format --check src tests
+      - run: uv run pyright src
+      - run: uv run pytest -m "not integration"
+      - run: uv build

eiax-0.1.0/.gitignore

@@ -0,0 +1,24 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv/
+.venv
+
+# Secrets and caches
+.env
+.pypirc
+.cache/
+.pytest_cache/
+.ruff_cache/
+
+# Test artifacts (but keep the shipped catalog data files)
+*.parquet
+!src/eiax/catalog/*.parquet
+
+docs/

eiax-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

eiax-0.1.0/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes are documented here. Format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versioning follows
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-06-26
+
+Initial release — Polars-native EIA Open Data API v2 client.
+
+### Added
+
+- `fetch()` / `fetch_async()` with auto-pagination and parallel page fetches.
+- Offline route catalog (~230 routes): `search()`, `help_route()`, `facet_values()`.
+- Catalog helpers in `eiax.catalog`: `list_routes()`, `list_children()`, `describe_node()`, `get_route()`.
+- Parquet + SQLite cache with gap detection and configurable TTL.
+- `EIAClient` with sync/async HTTP, rate limiting, and retries on 429/5xx.
+- `to_wide()` for reshaping long frames to wide period-indexed tables.
+- Settings via `EIA_API_KEY`, `EIA_CACHE_DIR`, `EIA_CACHE_ENABLED`, `EIA_CACHE_TTL_HOURS`, `EIA_RATE_LIMIT`.
+- Typed exceptions: `AuthenticationError`, `RateLimitError`, `EmptyResultError`, `UnknownSeriesError`, `EIAError`.
+- Optional `[fastjson]` extra for `orjson`-backed JSON decode.

eiax-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 forest green
+
+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.

eiax-0.1.0/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: eiax
+Version: 0.1.0
+Summary: Fast, unofficial Python client for the EIA Open Data API v2 (Polars-native, cached)
+Project-URL: Homepage, https://github.com/frstgrn/eiax
+Project-URL: Repository, https://github.com/frstgrn/eiax
+Project-URL: Issues, https://github.com/frstgrn/eiax/issues
+Author: forest green
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api-client,eia,electricity,energy,open-data,polars,time-series
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.28
+Requires-Dist: polars>=1.0
+Requires-Dist: pyarrow>=18
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: pyright>=1.1; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.9; extra == 'dev'
+Provides-Extra: fastjson
+Requires-Dist: orjson>=3.10; extra == 'fastjson'
+Description-Content-Type: text/markdown
+
+# eiax
+
+Unofficial Python client for the EIA Open Data API v2. polars-native, auto-paginating, and parquet cached.
+
+## Installation
+
+```bash
+pip install eiax # install eiax[fastjson] to use orjson for faster loads
+```
+
+eiax requires Python 3.12+.
+
+## API key
+
+Get a key at [eia.gov/opendata/register.php](https://www.eia.gov/opendata/register.php). Browsing the offline catalog (`search`, `help_route`, `facet_values`) does not need a key.
+
+Provide the key any of these ways (highest precedence first):
+
+```python
+import eiax
+
+# 1. Explicit argument
+client = eiax.EIAClient(api_key="your_key")
+# 2. Environment variable (best for pipelines / CI)
+#   export EIA_API_KEY=your_key
+# 3. A local .env file (best for development)
+#   EIA_API_KEY=your_key
+```
+
+## License & attribution
+
+eiax is released under the [MIT License](LICENSE). It is not affiliated with the U.S. EIA.

eiax-0.1.0/README.md

@@ -0,0 +1,32 @@
+# eiax
+
+Unofficial Python client for the EIA Open Data API v2. polars-native, auto-paginating, and parquet cached.
+
+## Installation
+
+```bash
+pip install eiax # install eiax[fastjson] to use orjson for faster loads
+```
+
+eiax requires Python 3.12+.
+
+## API key
+
+Get a key at [eia.gov/opendata/register.php](https://www.eia.gov/opendata/register.php). Browsing the offline catalog (`search`, `help_route`, `facet_values`) does not need a key.
+
+Provide the key any of these ways (highest precedence first):
+
+```python
+import eiax
+
+# 1. Explicit argument
+client = eiax.EIAClient(api_key="your_key")
+# 2. Environment variable (best for pipelines / CI)
+#   export EIA_API_KEY=your_key
+# 3. A local .env file (best for development)
+#   EIA_API_KEY=your_key
+```
+
+## License & attribution
+
+eiax is released under the [MIT License](LICENSE). It is not affiliated with the U.S. EIA.

eiax-0.1.0/pyproject.toml

@@ -0,0 +1,90 @@
+[project]
+name = "eiax"
+dynamic = ["version"]
+description = "Fast, unofficial Python client for the EIA Open Data API v2 (Polars-native, cached)"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "forest green" }]
+keywords = [
+  "eia",
+  "energy",
+  "open-data",
+  "polars",
+  "electricity",
+  "api-client",
+  "time-series",
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Scientific/Engineering",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Typing :: Typed",
+]
+dependencies = [
+  "httpx>=0.28",
+  "polars>=1.0",
+  "pyarrow>=18",
+  "pydantic>=2.0",
+  "pydantic-settings>=2.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/frstgrn/eiax"
+Repository = "https://github.com/frstgrn/eiax"
+Issues = "https://github.com/frstgrn/eiax/issues"
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8",
+  "pytest-asyncio>=0.24",
+  "ruff>=0.9",
+  "pyright>=1.1",
+]
+fastjson = ["orjson>=3.10"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/eiax/__version__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/eiax"]
+
+[tool.hatch.build.targets.wheel.force-include]
+"src/eiax/catalog/routes.parquet" = "eiax/catalog/routes.parquet"
+"src/eiax/catalog/nodes.parquet" = "eiax/catalog/nodes.parquet"
+"src/eiax/catalog/facet_values.parquet" = "eiax/catalog/facet_values.parquet"
+"src/eiax/catalog/branch_notes.json" = "eiax/catalog/branch_notes.json"
+
+[tool.uv]
+package = true
+
+[tool.ruff]
+line-length = 88
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.pyright]
+include = ["src"]
+pythonVersion = "3.12"
+typeCheckingMode = "basic"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+markers = [
+  "integration: live EIA API tests (needs EIA_API_KEY)",
+]