Metadata-Version: 2.4
Name: parsimony-eia
Version: 0.5.0
Summary: U.S. Energy Information Administration connector for the parsimony framework
Project-URL: Homepage, https://www.eia.gov
Project-URL: Repository, https://github.com/ockham-sh/parsimony-connectors
Project-URL: Issues, https://github.com/ockham-sh/parsimony-connectors/issues
Author-email: "Ockham.sh" <team@ockham.sh>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: connectors,data,eia,finance,parsimony
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: pandas<3,>=2.3.0
Requires-Dist: parsimony-core<0.6,>=0.5.0
Requires-Dist: pydantic<3,>=2.11.1
Provides-Extra: dev
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: pytest-asyncio>=1.3.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=9.0.3; extra == 'dev'
Requires-Dist: respx>=0.22.0; extra == 'dev'
Requires-Dist: ruff>=0.15.10; extra == 'dev'
Description-Content-Type: text/markdown

# parsimony-eia

U.S. Energy Information Administration (EIA) connector — fetches energy data (petroleum, electricity, natural gas, coal, renewables) from the EIA v2 Open Data API.

Part of the [parsimony-connectors](https://github.com/ockham-sh/parsimony-connectors) monorepo. Distributed standalone on PyPI as `parsimony-eia`.

## Connectors

| Name | Kind | Description |
|---|---|---|
| `eia_fetch` | fetch | Fetch dataset by API `route` (e.g. `petroleum/pri/spt`), with optional `frequency`, `start`, `end`. |
| `enumerate_eia` | enumerator | Enumerate top-level EIA API routes for catalog indexing. |

## Install

```bash
pip install parsimony-eia
```

Pulls in `parsimony-core>=0.4,<0.5` automatically. Verify discovery:

```bash
python -c "from parsimony import discover; print([p.name for p in discover.iter_providers()])"
```

## Configuration

Set the following environment variable:

```bash
export EIA_API_KEY="<your-key>"
```

Get a free key at https://www.eia.gov/opendata/register.php.

## Quick start

```python
import asyncio
from parsimony_eia import CONNECTORS

async def main():
    connectors = CONNECTORS.bind_env()
    result = await connectors["eia_fetch"](route="petroleum/pri/spt", frequency="monthly")
    print(result.data.head())

asyncio.run(main())
```

For multi-plugin composition:

```python
from parsimony import discover
connectors = discover.load_all().bind_env()
```

## Provider

- Homepage: https://www.eia.gov
- API docs: https://www.eia.gov/opendata/documentation.php

## License

See [LICENSE](./LICENSE).
