| Name | eia JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | |
| Summary | Client for interacting with the EIA API |
| upload_time | 2023-05-25 19:44:01 |
| maintainer | |
| docs_url | None |
| author | James Campbell |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2023 James Campbell 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. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# EIA
The client exposes a simple interface to the EIA API.
Huge thanks to the EIA for providing this API
See https://www.eia.gov/opendata/documentation.php for detailed API documentation
## Installation
```bash
pip install eia
```
## Examples
Get information on the available "petroleum" datasets.
```python
client.dataset_info("petroleum")
```
Get information on operational and power data, including generation.
```python
# Series Info includes data series with specific data elements and facets
operational = client.series_info("electricity/electric-power-operational-data")
operational.data
```
See examples in the [example](example/example.ipynb) directory.
Note: the client does not manage rate limits. See the [EIA API documentation](https://www.eia.gov/opendata/documentation.php) for more information on rate limits.
Raw data
{
"_id": null,
"home_page": "",
"name": "eia",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "James Campbell",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/25/63/05ad0baafb39fd8398b2656f13dce2fc9ee15b603dbd41f1a99a6f6689a4/eia-0.3.0.tar.gz",
"platform": null,
"description": "# EIA\n\nThe client exposes a simple interface to the EIA API.\n\nHuge thanks to the EIA for providing this API\nSee https://www.eia.gov/opendata/documentation.php for detailed API documentation\n\n## Installation\n\n```bash\npip install eia\n```\n\n## Examples\n\nGet information on the available \"petroleum\" datasets.\n\n```python\nclient.dataset_info(\"petroleum\")\n```\n\nGet information on operational and power data, including generation.\n```python\n# Series Info includes data series with specific data elements and facets\noperational = client.series_info(\"electricity/electric-power-operational-data\")\noperational.data\n```\n\nSee examples in the [example](example/example.ipynb) directory.\n\nNote: the client does not manage rate limits. See the [EIA API documentation](https://www.eia.gov/opendata/documentation.php) for more information on rate limits.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 James Campbell 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. ",
"summary": "Client for interacting with the EIA API",
"version": "0.3.0",
"project_urls": {
"Bug Tracker": "https://github.com/jcampbell/eia/issues",
"Homepage": "https://github.com/jcampbell/eia"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b9b1b4469e6a90f257b6ce7916a7a171722701a9b422e82985c79f4b19b3d0a5",
"md5": "f006a03c503a430b23db5cab64ca8dd9",
"sha256": "4032b08844527883a9e9cf453f64d92af11c9544b0c4a21d1f4d4d19bb0753c2"
},
"downloads": -1,
"filename": "eia-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f006a03c503a430b23db5cab64ca8dd9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7592,
"upload_time": "2023-05-25T19:44:00",
"upload_time_iso_8601": "2023-05-25T19:44:00.114067Z",
"url": "https://files.pythonhosted.org/packages/b9/b1/b4469e6a90f257b6ce7916a7a171722701a9b422e82985c79f4b19b3d0a5/eia-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "256305ad0baafb39fd8398b2656f13dce2fc9ee15b603dbd41f1a99a6f6689a4",
"md5": "55026a3d55635c25a28eeba088ddc276",
"sha256": "77e7403fbc6b31b1e99601517c314633179583ffa82f0ebd22b3d2c77a63c497"
},
"downloads": -1,
"filename": "eia-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "55026a3d55635c25a28eeba088ddc276",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7831,
"upload_time": "2023-05-25T19:44:01",
"upload_time_iso_8601": "2023-05-25T19:44:01.847484Z",
"url": "https://files.pythonhosted.org/packages/25/63/05ad0baafb39fd8398b2656f13dce2fc9ee15b603dbd41f1a99a6f6689a4/eia-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-25 19:44:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jcampbell",
"github_project": "eia",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "eia"
}
