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.
