Metadata-Version: 2.3
Name: gridstatus
Version: 0.29.1
Summary: API to access energy data
License: LICENSE
Keywords: energy,independent system operator
Author: Max Kanter
Author-email: kmax12@gmail.com
Maintainer: Max Kanter
Maintainer-email: kmax12@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: beautifulsoup4 (>=4.8.13,<5.0.0)
Requires-Dist: certifi (>=2024.7.4,<2025.0.0)
Requires-Dist: cryptography (>=43.0.1,<44.0.0)
Requires-Dist: lxml (>=5.3.0,<6.0.0)
Requires-Dist: openpyxl (>=3.1.0,<4.0.0)
Requires-Dist: pandas (>=2.2.1,<3.0.0)
Requires-Dist: plotly (>=5.11.0,<6.0.0)
Requires-Dist: requests (>=2.32.2,<3.0.0)
Requires-Dist: setuptools (>=70.0.0,<71.0.0)
Requires-Dist: tabula-py (>=2.5.1,<3.0.0)
Requires-Dist: tabulate (>=0.9.0,<0.10.0)
Requires-Dist: termcolor (>=2.2.0,<3.0.0)
Requires-Dist: tornado (>=6.4.1,<7.0.0)
Requires-Dist: tqdm (>=4.64.1,<5.0.0)
Requires-Dist: urllib3 (>=2.2.2,<3.0.0)
Requires-Dist: xlrd (>=2.0.1,<3.0.0)
Requires-Dist: xmltodict (>=0.14.2,<0.15.0)
Requires-Dist: zipp (>=3.19.1,<4.0.0)
Project-URL: Changes, https://github.com/gridstatus/gridstatus/blob/main/CHANGELOG.md
Project-URL: Issue Tracker, https://github.com/gridstatus/gridstatus/issues
Project-URL: Source Code, https://github.com/gridstatus/gridstatus/
Description-Content-Type: text/markdown

<p align="center">
<img width=75% src="./gridstatus-header.png" alt="gridstatus logo" />
</p>

<p align="center">
    <!-- disable until tests more reliable -->
    <!-- <a href="https://github.com/gridstatus/gridstatus/actions?query=branch%3Amain+workflow%3ATests" target="_blank">
        <img src="https://github.com/gridstatus/gridstatus/workflows/Tests/badge.svg?branch=main" alt="Tests" />
    </a> -->
    <a href="https://codecov.io/gh/gridstatus/gridstatus" target="_blank">
        <img src="https://codecov.io/gh/gridstatus/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/gridstatus/gridstatus/issues)
- 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.11+. 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://opensource.gridstatus.io/) and view [example notebooks](https://opensource.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.

