Metadata-Version: 2.4
Name: gridstatus
Version: 0.32.0
Summary: API to access energy data
Project-URL: Source Code, https://github.com/gridstatus/gridstatus/
Project-URL: Changes, https://github.com/gridstatus/gridstatus/blob/main/CHANGELOG.md
Project-URL: Issue Tracker, https://github.com/gridstatus/gridstatus/issues
Author-email: Max Kanter <kmax12@gmail.com>, Will Koehrsen <will@gridstatus.com>, Ryan Kladar <ryan@gridstatus.com>
License: Copyright 2022 James Max Kanter
        
        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Keywords: energy,independent system operator
Requires-Python: <3.13,>=3.10
Requires-Dist: beautifulsoup4>=4.8.13
Requires-Dist: certifi>=2024.7.4
Requires-Dist: cryptography>=43.0.1
Requires-Dist: frozendict>=2.4.6
Requires-Dist: lxml>=5.3.0
Requires-Dist: openpyxl>=3.1.0
Requires-Dist: pandas>=2.2.1
Requires-Dist: pdfplumber>=0.11.5
Requires-Dist: plotly>=5.11.0
Requires-Dist: requests>=2.32.2
Requires-Dist: setuptools>=70.0.0
Requires-Dist: tabulate>=0.9.0
Requires-Dist: termcolor>=2.2.0
Requires-Dist: tqdm>=4.64.1
Requires-Dist: urllib3>=2.2.2
Requires-Dist: virtualenv>=20.26.6
Requires-Dist: xlrd>=2.0.1
Requires-Dist: xmltodict>=0.14.2
Requires-Dist: zipp>=3.19.1
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 uv

```
uv pip install gridstatus
```

Upgrade using the following command

```
uv 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.
