python-eia 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- python_eia-0.1.0/.github/workflows/publish-to-pypi.yml +26 -0
- python_eia-0.1.0/.gitignore +7 -0
- python_eia-0.1.0/PKG-INFO +59 -0
- python_eia-0.1.0/README.md +25 -0
- python_eia-0.1.0/eia/__init__.py +10 -0
- python_eia-0.1.0/eia/client.py +923 -0
- python_eia-0.1.0/examples/1_Generic/fuel-type-data/1_Download.ipynb +667 -0
- python_eia-0.1.0/examples/1_Generic/fuel-type-data/2_Analysis.ipynb +189 -0
- python_eia-0.1.0/examples/1_Generic/steps/1_Download.ipynb +462 -0
- python_eia-0.1.0/examples/1_Generic/steps/2_Analysis.ipynb +677 -0
- python_eia-0.1.0/pyproject.toml +46 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
name: Publish Python 🐍 distribution 📦 to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [published]
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
build-and-publish:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
steps:
|
|
11
|
+
- uses: actions/checkout@v4
|
|
12
|
+
- name: Set up Python
|
|
13
|
+
uses: actions/setup-python@v5
|
|
14
|
+
with:
|
|
15
|
+
python-version: "3.11"
|
|
16
|
+
- name: Install build tools
|
|
17
|
+
run: |
|
|
18
|
+
pip install --upgrade pip
|
|
19
|
+
pip install hatch twine
|
|
20
|
+
- name: Build package
|
|
21
|
+
run: hatch build
|
|
22
|
+
- name: Publish to PyPI
|
|
23
|
+
env:
|
|
24
|
+
TWINE_USERNAME: __token__
|
|
25
|
+
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
|
|
26
|
+
run: twine upload dist/*
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: python-eia
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A Python client for the U.S. Energy Information Administration (EIA) API v2
|
|
5
|
+
Project-URL: Homepage, https://github.com/datons/python-eia
|
|
6
|
+
Project-URL: Repository, https://github.com/datons/python-eia.git
|
|
7
|
+
Project-URL: Issues, https://github.com/datons/python-eia/issues
|
|
8
|
+
Author-email: Jesus Lopez <jesus.lopez@datons.ai>
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.7
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.8
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
21
|
+
Classifier: Topic :: Scientific/Engineering
|
|
22
|
+
Requires-Python: >=3.7
|
|
23
|
+
Requires-Dist: requests>=2.31.0
|
|
24
|
+
Requires-Dist: urllib3>=2.0.0
|
|
25
|
+
Provides-Extra: dev
|
|
26
|
+
Requires-Dist: black>=22.0; extra == 'dev'
|
|
27
|
+
Requires-Dist: flake8>=3.9; extra == 'dev'
|
|
28
|
+
Requires-Dist: isort>=5.0; extra == 'dev'
|
|
29
|
+
Requires-Dist: mypy>=0.900; extra == 'dev'
|
|
30
|
+
Requires-Dist: pytest-cov>=2.0; extra == 'dev'
|
|
31
|
+
Requires-Dist: pytest>=6.0; extra == 'dev'
|
|
32
|
+
Requires-Dist: types-requests>=2.25.0; extra == 'dev'
|
|
33
|
+
Description-Content-Type: text/markdown
|
|
34
|
+
|
|
35
|
+
# Python EIA Client
|
|
36
|
+
|
|
37
|
+
A minimalist Python client for the U.S. Energy Information Administration (EIA) API v2.
|
|
38
|
+
|
|
39
|
+
## Installation
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pip install python-eia
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## API Key
|
|
46
|
+
|
|
47
|
+
You must request an API key from the [EIA website](https://www.eia.gov/opendata/register.php).
|
|
48
|
+
|
|
49
|
+
Set your API key in one of two ways:
|
|
50
|
+
- Add it to a `.env` file as `EIA_API_KEY=your_token`
|
|
51
|
+
- Or pass it directly as a parameter: `EIAClient(api_key="your_token")`
|
|
52
|
+
|
|
53
|
+
## Usage Example
|
|
54
|
+
|
|
55
|
+
See [examples/1_Generic/steps/1_Download.ipynb](examples/1_Generic/steps/1_Download.ipynb) for usage instructions and examples.
|
|
56
|
+
|
|
57
|
+
## License
|
|
58
|
+
|
|
59
|
+
MIT License
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Python EIA Client
|
|
2
|
+
|
|
3
|
+
A minimalist Python client for the U.S. Energy Information Administration (EIA) API v2.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pip install python-eia
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## API Key
|
|
12
|
+
|
|
13
|
+
You must request an API key from the [EIA website](https://www.eia.gov/opendata/register.php).
|
|
14
|
+
|
|
15
|
+
Set your API key in one of two ways:
|
|
16
|
+
- Add it to a `.env` file as `EIA_API_KEY=your_token`
|
|
17
|
+
- Or pass it directly as a parameter: `EIAClient(api_key="your_token")`
|
|
18
|
+
|
|
19
|
+
## Usage Example
|
|
20
|
+
|
|
21
|
+
See [examples/1_Generic/steps/1_Download.ipynb](examples/1_Generic/steps/1_Download.ipynb) for usage instructions and examples.
|
|
22
|
+
|
|
23
|
+
## License
|
|
24
|
+
|
|
25
|
+
MIT License
|