Metadata-Version: 2.4
Name: python-eia
Version: 0.1.0
Summary: A Python client for the U.S. Energy Information Administration (EIA) API v2
Project-URL: Homepage, https://github.com/datons/python-eia
Project-URL: Repository, https://github.com/datons/python-eia.git
Project-URL: Issues, https://github.com/datons/python-eia/issues
Author-email: Jesus Lopez <jesus.lopez@datons.ai>
License-Expression: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
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: Topic :: Scientific/Engineering
Requires-Python: >=3.7
Requires-Dist: requests>=2.31.0
Requires-Dist: urllib3>=2.0.0
Provides-Extra: dev
Requires-Dist: black>=22.0; extra == 'dev'
Requires-Dist: flake8>=3.9; extra == 'dev'
Requires-Dist: isort>=5.0; extra == 'dev'
Requires-Dist: mypy>=0.900; extra == 'dev'
Requires-Dist: pytest-cov>=2.0; extra == 'dev'
Requires-Dist: pytest>=6.0; extra == 'dev'
Requires-Dist: types-requests>=2.25.0; extra == 'dev'
Description-Content-Type: text/markdown

# Python EIA Client

A minimalist Python client for the U.S. Energy Information Administration (EIA) API v2.

## Installation

```bash
pip install python-eia
```

## API Key

You must request an API key from the [EIA website](https://www.eia.gov/opendata/register.php).

Set your API key in one of two ways:
- Add it to a `.env` file as `EIA_API_KEY=your_token`
- Or pass it directly as a parameter: `EIAClient(api_key="your_token")`

## Usage Example

See [examples/1_Generic/steps/1_Download.ipynb](examples/1_Generic/steps/1_Download.ipynb) for usage instructions and examples.

## License

MIT License 