Package Health Score

69 / 100

security
No known security issues
popularity
Limited
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Popularity

Limited

GitHub Stars: 53
Forks: 6
Contributors: 4

Direct Usage Popularity

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

Security

No known security issues

Security and license risk for latest version

Release Date: Dec 5, 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

MIT

Security Policy

We found a way for you to contribute to the project! Looks like SynopticPy 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: 0
Open PR: 0
Last Release: 18 days ago
Last Commit: 18 days ago

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

We found that SynopticPy 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

Sustainable

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

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like SynopticPy 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: >=3.11

Age: 4 years
Latest Release: 18 days ago
Dependencies: 3 Direct
Versions: 9
Maintainers: 0
Wheels: OS Independent

Readme

Synoptic API for Python

License

📘 Documentation | 💬 Discussions | 🚑 Issues

Synoptic's Weather API provides real-time and historical surface-based weather and environmental observations for thousands of mesonet stations, and the open-access data is free. More data and enhanced services may be purchased (from Synoptic, not me).

I'm a Synoptic user. I wrote this package to conveniently request data from Synoptic in a Pythonic way and convert its returned JSON to a Polars DataFrame.

from datetime import timedelta
from synoptic import TimeSeries

df = TimeSeries(
    stid="wbb",
    recent=timedelta(minutes=30)
).df()

alt text

I'm sharing this package to improve my skills with Polars and gain more experience in building and maintaining open-source Python packages. If you came across this package, I hope you find it valuable.

Best of Luck 🍀
-Brian

🐍 Install

pip install SynopticPy

conda install -c conda-forge synopticpy

Configure Token

> [!IMPORTANT] > > ## 🎟️ To use SynopticPy you need a Synoptic API token.

There are three ways you can configure your Synoptic API token:

Set an environment variable SYNOPTIC_TOKEN with your token. For example, in bash:
```
export SYNOPTIC_TOKEN="yourTokenHere123456789"
```
Create a file ~/.config/SynopticPy/config.toml with the following
```
token = "yourTokenHere123456789"
```

Pass your token whenever you use one of SynopticPy's classes.

TimeSeries(
    stid="wbb",
    recent=30,
    token="yourTokenHere123456789"
)

How to Cite and Acknowledge

If SynopticPy played an important role in your work, please tell me about it! Also, consider including a citation or acknowledgement in your article or product.

Suggested Citation

> Blaylock, B. K. (YEAR). SynopticPy: Synoptic API for Python (Version 20??.?.?) [Computer software]. https://github.com/blaylockbk/SynopticPy

Suggested Acknowledgment

> A portion of this work used code generously provided by Brian Blaylock's SynopticPy Python package (https://github.com/blaylockbk/SynopticPy)

> [!TIP] > > ### 📈 See also my SynopticPy Web App which lets you plot station data in your browser powered by pyscript!

SynopticPy dependencies

numpy requests toml

FAQs

What is SynopticPy?

Retrieve mesonet weather data as Polars DataFrames from Synoptic's Weather API. Visit Snyk Advisor to see a full health score report for SynopticPy, including popularity, security, maintenance & community analysis.

Is SynopticPy popular?

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

Is SynopticPy well maintained?

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

Is SynopticPy safe to use?

The python package SynopticPy 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 23 December-2024, at 16:25 (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

SynopticPy

Retrieve mesonet weather data as Polars DataFrames from Synoptic's Weather API. For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

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

Synoptic API for Python

📘 Documentation | 💬 Discussions | 🚑 Issues

🐍 Install

Configure Token

How to Cite and Acknowledge

SynopticPy dependencies

FAQs

What is SynopticPy?

Is SynopticPy popular?

Is SynopticPy well maintained?

Is SynopticPy 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

Explore Similar Packages

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

Synoptic API for Python

📘 Documentation | 💬 Discussions | 🚑 Issues

🐍 Install

Configure Token

How to Cite and Acknowledge

SynopticPy dependencies

FAQs

What is SynopticPy?

Is SynopticPy popular?

Is SynopticPy well maintained?

Is SynopticPy 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