{"id":33149010,"url":"https://github.com/blaylockbk/SynopticPy","last_synced_at":"2025-12-10T00:01:19.446Z","repository":{"id":47006583,"uuid":"288617886","full_name":"blaylockbk/SynopticPy","owner":"blaylockbk","description":"Retrieve mesonet weather data as Polars DataFrames from Synoptic's Weather API.","archived":false,"fork":false,"pushed_at":"2025-10-09T20:55:48.000Z","size":36114,"stargazers_count":70,"open_issues_count":6,"forks_count":7,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-12-07T16:46:24.505Z","etag":null,"topics":["mesonet","mesowest","polars","python","synoptic-api","weather"],"latest_commit_sha":null,"homepage":"https://synopticpy.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blaylockbk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-08-19T02:52:50.000Z","updated_at":"2025-11-23T21:18:24.000Z","dependencies_parsed_at":"2025-09-28T01:24:49.985Z","dependency_job_id":null,"html_url":"https://github.com/blaylockbk/SynopticPy","commit_stats":{"total_commits":353,"total_committers":9,"mean_commits":39.22222222222222,"dds":0.2974504249291785,"last_synced_commit":"378b3e1a0cc4b7170034cb0e1386c19a2f354eb1"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/blaylockbk/SynopticPy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blaylockbk%2FSynopticPy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blaylockbk%2FSynopticPy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blaylockbk%2FSynopticPy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blaylockbk%2FSynopticPy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blaylockbk","download_url":"https://codeload.github.com/blaylockbk/SynopticPy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blaylockbk%2FSynopticPy/sbom","scorecard":{"id":242907,"data":{"date":"2025-08-11","repo":{"name":"github.com/blaylockbk/SynopticPy","commit":"be8d588f3331d55126f32a299682ca9ecad09d94"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/22 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/release_to_pypi.yml:1","Info: topLevel 'contents' permission set to 'read': .github/workflows/static.yml:14","Warn: no topLevel permission defined: .github/workflows/tests-python.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release_to_pypi.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/blaylockbk/SynopticPy/release_to_pypi.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release_to_pypi.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/blaylockbk/SynopticPy/release_to_pypi.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release_to_pypi.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/blaylockbk/SynopticPy/release_to_pypi.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/static.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/blaylockbk/SynopticPy/static.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/static.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/blaylockbk/SynopticPy/static.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/static.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/blaylockbk/SynopticPy/static.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/static.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/blaylockbk/SynopticPy/static.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/static.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/blaylockbk/SynopticPy/static.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests-python.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/blaylockbk/SynopticPy/tests-python.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests-python.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/blaylockbk/SynopticPy/tests-python.yml/main?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/release_to_pypi.yml:27","Info:   0 out of   9 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned","Info:   1 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release_to_pypi.yml:9"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 11 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":1,"reason":"9 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6","Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-3965-hpx2-q597","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T06:57:56.014Z","repository_id":47006583,"created_at":"2025-08-17T06:57:56.014Z","updated_at":"2025-08-17T06:57:56.014Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27597922,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-08T02:00:07.111Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mesonet","mesowest","polars","python","synoptic-api","weather"],"created_at":"2025-11-15T17:00:26.092Z","updated_at":"2025-12-10T00:01:19.440Z","avatar_url":"https://github.com/blaylockbk.png","language":"Python","funding_links":[],"categories":["Sustainable Development"],"sub_categories":["Data Catalogs and Interfaces"],"readme":"\u003cdiv\n    align='center'\n\u003e\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/blaylockbk/SynopticPy/refs/heads/56-rewrite-using-polars/docs/_static/SynopticPy_white.svg\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/blaylockbk/SynopticPy/refs/heads/56-rewrite-using-polars/docs/_static/SynopticPy_blue.svg\"\u003e\n  \u003cimg alt=\"Shows a black logo in light color mode and a white one in dark color mode.\" src=\"https://raw.githubusercontent.com/blaylockbk/SynopticPy/refs/heads/56-rewrite-using-polars/docs/_static/SynopticPy_blue.svg\" width=300\u003e\n\u003c/picture\u003e\n\n## Synoptic API for Python\n\n\u003c!-- Badges --\u003e\n\n[![PyPI](https://img.shields.io/pypi/v/SynopticPy)](https://pypi.python.org/pypi/SynopticPy/)\n[![Conda Version](https://img.shields.io/conda/vn/conda-forge/synopticpy.svg)](https://anaconda.org/conda-forge/synopticpy)\n[![DOI](https://zenodo.org/badge/288617886.svg)](https://zenodo.org/badge/latestdoi/288617886)\n\n![License](https://img.shields.io/github/license/blaylockbk/SynopticPy)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![Tests (Python)](https://github.com/blaylockbk/SynopticPy/actions/workflows/tests-python.yml/badge.svg)](https://github.com/blaylockbk/SynopticPy/actions/workflows/tests-python.yml)\n[![Documentation Status](https://readthedocs.org/projects/synopticpy/badge/?version=latest)](https://synopticpy.readthedocs.io/?badge=latest)\n[![Python](https://img.shields.io/pypi/pyversions/SynopticPy.svg)](https://pypi.org/project/SynopticPy/)\n[![Conda Recipe](https://img.shields.io/badge/recipe-synopticpy-green.svg)](https://anaconda.org/conda-forge/synopticpy)\n[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/synopticpy.svg)](https://anaconda.org/conda-forge/synopticpy)\n\n\u003c!-- (Badges) --\u003e\n\n## 📘 [Documentation](https://synopticpy.readthedocs.io/) | [💬 Discussions](https://github.com/blaylockbk/SynopticPy/discussions) | [🚑 Issues](https://github.com/blaylockbk/SynopticPy/issues)\n\n\u003c/div\u003e\n\n[Synoptic's Weather API](https://synopticdata.com/weatherapi/) provides real-time and historical surface-based weather and environmental observations for thousands of mesonet stations, and the [open-access data](https://synopticdata.com/pricing/open-access-pricing/) is _free_. More data and enhanced services may be purchased (from Synoptic, not me).\n\nI'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](https://docs.pola.rs/user-guide/getting-started/)**.\n\n```python\nfrom datetime import timedelta\nfrom synoptic import TimeSeries\n\ndf = TimeSeries(\n    stid=\"wbb\",\n    recent=timedelta(minutes=30)\n).df()\n```\n\n![alt text](docs/_static/json_to_polars.png)\n\nI'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.\n\n**Best of Luck 🍀**  \n-Brian\n\n# 🐍 Install\n\n```bash\npip install SynopticPy\n```\n\n```bash\nconda install -c conda-forge synopticpy\n```\n\n## Configure Token\n\n\u003e [!IMPORTANT]\n\u003e\n\u003e ## 🎟️ To use SynopticPy you need a [Synoptic API token](https://customer.synopticdata.com/).\n\nThere are three ways you can configure your Synoptic API token:\n\n1. Set an environment variable `SYNOPTIC_TOKEN` with your token. For example, in bash:\n   ```bash\n   export SYNOPTIC_TOKEN=\"yourTokenHere123456789\"\n   ```\n1. Create a file `~/.config/SynopticPy/config.toml` with the following\n   ```toml\n   token = \"yourTokenHere123456789\"\n   ```\n1. Pass your token whenever you use one of SynopticPy's classes.\n   ```python\n   TimeSeries(\n       stid=\"wbb\",\n       recent=30,\n       token=\"yourTokenHere123456789\"\n   )\n   ```\n\n# How to Cite and Acknowledge\n\nIf SynopticPy played an important role in your work, please [tell me about it](https://github.com/blaylockbk/SynopticPY/discussions/categories/show-and-tell)! Also, consider including a citation or acknowledgement in your article or product.\n\n**_Suggested Citation_**\n\n\u003e Blaylock, B. K. (YEAR). SynopticPy: Synoptic API for Python (Version 20??.?.?) [Computer software]. https://github.com/blaylockbk/SynopticPy\n\n**_Suggested Acknowledgment_**\n\n\u003e A portion of this work used code generously provided by Brian Blaylock's SynopticPy Python package (https://github.com/blaylockbk/SynopticPy)\n\n\u003cbr\u003e\n\u003chr\u003e\n\n\u003e [!TIP]\n\u003e\n\u003e ### 📈 See also my [SynopticPy Web App](https://blaylockbk.github.io/SynopticPy) which lets you plot station data in your browser powered by [pyscript](https://pyscript.net/)!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblaylockbk%2FSynopticPy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblaylockbk%2FSynopticPy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblaylockbk%2FSynopticPy/lists"}