View gridstatus on Snyk Open Source Advisor

Package Health Score

78 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Popularity

Small

GitHub Stars: 282
Forks: 49
Contributors: 30

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package gridstatus, we found that it has been starred 282 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Oct 4, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

BSD-3-Clause

Security Policy

We found a way for you to contribute to the project! Looks like gridstatus is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 48
Open PR: 8
Last Release: 2 months ago
Last Commit: 29 days ago

Further analysis of the maintenance status of gridstatus based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that gridstatus demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the gridstatus repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like gridstatus is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: <4.0,>=3.9

Age: 2 years
Latest Release: 2 months ago
Dependencies: 0 Direct
Versions: 18
Maintainers: 1
Wheels: OS Independent

Readme

gridstatus logo

<a href="https://codecov.io/gh/kmax12/gridstatus">
    <img alt="Code Coverage" src="https://codecov.io/gh/kmax12/gridstatus/branch/main/graph/badge.svg">
</a>
<a href="https://badge.fury.io/py/gridstatus">
    <img alt="PyPI version" src="https://badge.fury.io/py/gridstatus.svg?maxAge=2592000">
</a>

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.

If you are trying to use our hosted API, you might want to check out the gridstatusio library here.

To learn more about our hosted API visit: https://www.gridstatus.io/api.

Community

Need Help? Post a GitHub issue
Want to chat? Join our Slack
Want to stay updated? Follow us on Twitter @grid_status
Want to contribute? Read our Contributing Guide

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 for the required environment variables and how to register for them

Documentation and Examples

To learn more, visit the documentation and view example notebooks.

Get Help

We'd love to answer any usage or data access questions! Please let us know by posting a GitHub issue.

FAQs

What is gridstatus?

API to access energy data. Visit Snyk Advisor to see a full health score report for gridstatus, including popularity, security, maintenance & community analysis.

Is gridstatus popular?

The python package gridstatus receives a total of 1,790 weekly downloads. As such, gridstatus popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is gridstatus well maintained?

We found that gridstatus demonstrated a healthy version release cadence and project activity. It has a community of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is gridstatus safe to use?

The python package gridstatus was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 22 November-2024, at 03:14 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

gridstatus

API to access energy data For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

GridStatus.io and Hosted API

Community

Installation

Environment Variables

Documentation and Examples

Get Help

FAQs

What is gridstatus?

Is gridstatus popular?

Is gridstatus well maintained?

Is gridstatus safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

GridStatus.io and Hosted API

Community

Installation

Environment Variables

Documentation and Examples

Get Help

FAQs

What is gridstatus?

Is gridstatus popular?

Is gridstatus well maintained?

Is gridstatus safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues