<p align="center">
<img width=75% src="https://github.com/gridstatus/gridstatus/blob/main/gridstatus-header.png" alt="gridstatus logo" />
</p>
<p align="center">
<!-- disable until tests more reliable -->
<!-- <a href="https://github.com/kmax12/gridstatus/actions?query=branch%3Amain+workflow%3ATests" target="_blank">
<img src="https://github.com/kmax12/gridstatus/workflows/Tests/badge.svg?branch=main" alt="Tests" />
</a> -->
<a href="https://codecov.io/gh/kmax12/gridstatus" target="_blank">
<img src="https://codecov.io/gh/kmax12/gridstatus/branch/main/graph/badge.svg" alt="Code Coverage"/>
</a>
<a href="https://badge.fury.io/py/gridstatus" target="_blank">
<img src="https://badge.fury.io/py/gridstatus.svg?maxAge=2592000" alt="PyPI version">
</a>
</p>
`gridstatus` is a Python library that provides a uniform API for accessing electricity supply, demand, and pricing data for the major Independent System Operators (ISOs) in the United States. It currently supports data from CAISO, SPP, ISONE, MISO, ERCOT, NYISO, PJM, IESO, and the EIA.
## GridStatus.io and Hosted API
To preview some of the data this library provides access to, visit [GridStatus.io](https://www.gridstatus.io/).
If you are trying to use our hosted API, you might want to check out the gridstatusio library [here](https://github.com/gridstatus/gridstatusio).
To learn more about our hosted API visit: https://www.gridstatus.io/api.
## Community
- Need Help? Post a [GitHub issue](https://github.com/kmax12/gridstatus/issues)
- Want to chat? Join our [Slack](https://join.slack.com/t/gridstatus/shared_invite/zt-1jk6vlzt2-Lzz4pdpjkJYVUJkynOiIvQ)
- Want to stay updated? Follow us on Twitter [@grid_status](https://twitter.com/grid_status)
- Want to contribute? Read our [Contributing Guide](CONTRIBUTING.md)
## Installation
`gridstatus` supports python 3.9+. Install with pip
```
python -m pip install gridstatus
```
Upgrade using the following command
```
python -m pip install --upgrade gridstatus
```
## Environment Variables
- Some parsers require the use of environment variables
- The `EIA` class
- The `ErcotAPI` class
- Environment variables can be set in the following ways
- In a `.env` file in the root of the project
- In the environment where the code is run
- See [.env.template](.env.template) for the required environment variables and how to register for them
## Documentation and Examples
To learn more, visit the [documentation](https://docs.gridstatus.io/) and view [example notebooks](https://docs.gridstatus.io/en/latest/Examples/caiso/index.html).
## Get Help
We'd love to answer any usage or data access questions! Please let us know by posting a GitHub issue.
Raw data
{
"_id": null,
"home_page": null,
"name": "gridstatus",
"maintainer": "Max Kanter",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "kmax12@gmail.com",
"keywords": "energy, independent system operator",
"author": "Max Kanter",
"author_email": "kmax12@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4b/72/bcb10c68cd9ce2865055b53b807c81f976764599dba343ddeb6346ed2c39/gridstatus-0.28.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n<img width=75% src=\"https://github.com/gridstatus/gridstatus/blob/main/gridstatus-header.png\" alt=\"gridstatus logo\" />\n</p>\n\n<p align=\"center\">\n <!-- disable until tests more reliable -->\n <!-- <a href=\"https://github.com/kmax12/gridstatus/actions?query=branch%3Amain+workflow%3ATests\" target=\"_blank\">\n <img src=\"https://github.com/kmax12/gridstatus/workflows/Tests/badge.svg?branch=main\" alt=\"Tests\" />\n </a> -->\n <a href=\"https://codecov.io/gh/kmax12/gridstatus\" target=\"_blank\">\n <img src=\"https://codecov.io/gh/kmax12/gridstatus/branch/main/graph/badge.svg\" alt=\"Code Coverage\"/>\n </a>\n <a href=\"https://badge.fury.io/py/gridstatus\" target=\"_blank\">\n <img src=\"https://badge.fury.io/py/gridstatus.svg?maxAge=2592000\" alt=\"PyPI version\">\n </a>\n</p>\n\n`gridstatus` is a Python library that provides a uniform API for accessing electricity supply, demand, and pricing data for the major Independent System Operators (ISOs) in the United States. It currently supports data from CAISO, SPP, ISONE, MISO, ERCOT, NYISO, PJM, IESO, and the EIA.\n\n## GridStatus.io and Hosted API\nTo preview some of the data this library provides access to, visit [GridStatus.io](https://www.gridstatus.io/).\n\nIf you are trying to use our hosted API, you might want to check out the gridstatusio library [here](https://github.com/gridstatus/gridstatusio).\n\nTo learn more about our hosted API visit: https://www.gridstatus.io/api.\n\n## Community\n\n- Need Help? Post a [GitHub issue](https://github.com/kmax12/gridstatus/issues)\n- Want to chat? Join our [Slack](https://join.slack.com/t/gridstatus/shared_invite/zt-1jk6vlzt2-Lzz4pdpjkJYVUJkynOiIvQ)\n- Want to stay updated? Follow us on Twitter [@grid_status](https://twitter.com/grid_status)\n- Want to contribute? Read our [Contributing Guide](CONTRIBUTING.md)\n\n## Installation\n\n`gridstatus` supports python 3.9+. Install with pip\n\n```\npython -m pip install gridstatus\n```\n\nUpgrade using the following command\n\n```\npython -m pip install --upgrade gridstatus\n```\n\n## Environment Variables\n\n- Some parsers require the use of environment variables\n - The `EIA` class\n - The `ErcotAPI` class\n- Environment variables can be set in the following ways\n - In a `.env` file in the root of the project\n - In the environment where the code is run\n- See [.env.template](.env.template) for the required environment variables and how to register for them\n\n\n## Documentation and Examples\n\nTo learn more, visit the [documentation](https://docs.gridstatus.io/) and view [example notebooks](https://docs.gridstatus.io/en/latest/Examples/caiso/index.html).\n\n## Get Help\n\nWe'd love to answer any usage or data access questions! Please let us know by posting a GitHub issue.\n\n",
"bugtrack_url": null,
"license": "LICENSE",
"summary": "API to access energy data",
"version": "0.28.0",
"project_urls": {
"Changes": "https://github.com/kmax12/gridstatus/blob/main/CHANGELOG.md",
"Issue Tracker": "https://github.com/kmax12/gridstatus/issues",
"Source Code": "https://github.com/kmax12/gridstatus/"
},
"split_keywords": [
"energy",
" independent system operator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9509bc0e34fb6c9bfcd92ba3302834121e66c87e9cc6e4b69f3907dc7a03a517",
"md5": "345afa24a55f2871993a53f37c8aeb4f",
"sha256": "9a1fc5ffc30809909b41c9b0e625ddadc0c913a63a4eff90a375ddb049c14dcb"
},
"downloads": -1,
"filename": "gridstatus-0.28.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "345afa24a55f2871993a53f37c8aeb4f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 312062,
"upload_time": "2024-10-04T16:37:22",
"upload_time_iso_8601": "2024-10-04T16:37:22.319264Z",
"url": "https://files.pythonhosted.org/packages/95/09/bc0e34fb6c9bfcd92ba3302834121e66c87e9cc6e4b69f3907dc7a03a517/gridstatus-0.28.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b72bcb10c68cd9ce2865055b53b807c81f976764599dba343ddeb6346ed2c39",
"md5": "75442ac316852184689cc920f2e1ce45",
"sha256": "c6ab4bc577ffd613dc99ab4608839ff97d91573c73b88be0823affcb32ff10f8"
},
"downloads": -1,
"filename": "gridstatus-0.28.0.tar.gz",
"has_sig": false,
"md5_digest": "75442ac316852184689cc920f2e1ce45",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 289796,
"upload_time": "2024-10-04T16:37:24",
"upload_time_iso_8601": "2024-10-04T16:37:24.635491Z",
"url": "https://files.pythonhosted.org/packages/4b/72/bcb10c68cd9ce2865055b53b807c81f976764599dba343ddeb6346ed2c39/gridstatus-0.28.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-04 16:37:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kmax12",
"github_project": "gridstatus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gridstatus"
}
JSON
