tempestwx 0.0.2__tar.gz

tempestwx-0.0.2/.editorconfig

@@ -0,0 +1,29 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+max_line_length = 80
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.py]
+indent_size = 4
+
+[*.toml]
+indent_size = 4
+
+[{*.just, justfile}]
+indent_size = 4

tempestwx-0.0.2/.env.example

@@ -0,0 +1 @@
+TEMPEST_ACCESS_TOKEN="<personal_access_token>"

tempestwx-0.0.2/.github/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.x     | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Report via <https://github.com/greylabel/tempestwx/security/advisories>.
+
+Guidance: [Privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).

tempestwx-0.0.2/.github/actions/setup/action.yml

@@ -0,0 +1,15 @@
+name: Setup
+description: Setup for python + uv project workflows
+runs:
+  using: composite
+  steps:
+    - name: Setup Python
+      uses: actions/setup-python@v6
+      with:
+        python-version-file: .python-version
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+        version: "0.9.13"

tempestwx-0.0.2/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"

tempestwx-0.0.2/.github/workflows/check.yml

@@ -0,0 +1,17 @@
+name: Check
+on: [push, pull_request]
+concurrency:
+  cancel-in-progress: true
+  group: ${{ github.workflow }}-${{ github.ref }}
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ./.github/actions/setup
+      - run: uv sync --group=check
+      - run: uv run just check-code
+      - run: uv run just check-type
+      - run: uv run just check-format
+      - run: uv run just check-security
+      - run: uv run just check-coverage

tempestwx-0.0.2/.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Release
+
+on:
+  push:
+    tags:
+      # Publish on any tag starting with a `v`, e.g., v1.2.3
+      - v*
+
+jobs:
+  pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    # Environment and permissions trusted publishing.
+    environment:
+      # Environment must exist in the GitHub repository under Settings -> Environments
+      name: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ./.github/actions/setup
+      # Verify tag matches pyproject.toml version
+      - name: Verify version
+        run: |
+          TAG_VERSION=${GITHUB_REF#refs/tags/v}
+          PROJECT_VERSION=$(uv version --short)
+          if [ "$TAG_VERSION" != "$PROJECT_VERSION" ]; then
+            echo "Tag version ($TAG_VERSION) doesn't match project version ($PROJECT_VERSION)"
+            exit 1
+          fi
+      - name: Package
+        run: uv run just package
+      - name: Smoke test wheel artifact
+        run: uv run just test-wheel
+      - name: Smoke test sdist artifact
+        run: uv run just test-source
+      - name: Release
+        run: uv run just release-package

tempestwx-0.0.2/.gitignore

@@ -0,0 +1,223 @@
+config.json
+x.py
+
+###
+### https://github.com/github/gitignore/blob/main/Python.gitignore
+###
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

tempestwx-0.0.2/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+# https://pre-commit.com
+# https://pre-commit.com/hooks.html
+
+default_language_version:
+  python: python3.13
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 'v6.0.0'
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.14.7'
+    hooks:
+    # Run the linter (check only, no fixes)
+    - id: ruff-check
+    # Run the formatter (check only, no fixes)
+    - id: ruff-format
+      args: [ --check ]
+  - repo: https://github.com/PyCQA/bandit
+    rev: '1.9.2'
+    hooks:
+    - id: bandit
+      args: ["--recursive", "--configfile", "pyproject.toml", "src"]
+      pass_filenames: false

tempestwx-0.0.2/.python-version

@@ -0,0 +1 @@
+3.13

tempestwx-0.0.2/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## v0.0.1
+
+- Initial open source version.
+
+## v0.0.2
+
+- Fix GH Actions Release workflow.

tempestwx-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Grant Gaudet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tempestwx-0.0.2/PKG-INFO

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: tempestwx
+Version: 0.0.2
+Summary: Tempest SDK for Python
+Project-URL: repository, https://github.com/greylabel/tempestwx
+Author-email: Grant Gaudet <grant@greylabel.net>
+License: MIT
+License-File: LICENSE
+Keywords: api,tempest,weather
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.13
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic-settings>=2.11.0
+Requires-Dist: pydantic>=2.12.3
+Requires-Dist: python-dotenv>=1.1.1
+Description-Content-Type: text/markdown
+
+# Tempest
+
+Python SDK for the [Tempest API](https://apidocs.tempestwx.com/reference).
+
+## Installation
+
+Requires Python 3.13+.
+
+- From PyPI:
+
+```bash
+  pip install tempestwx
+```
+
+## Usage
+
+Ensure `TEMPEST_ACCESS_TOKEN` is set (via environment or `.env`).
+
+```python
+from tempestwx import Tempest
+
+# Recommended: Use context manager for automatic resource cleanup
+with Tempest() as twx:
+    stations = twx.stations()
+    print(stations)
+
+# Alternative: Manual resource management
+twx = Tempest()
+try:
+    stations = twx.stations()
+    print(stations)
+finally:
+    twx.close()
+```
+
+The client returns Pydantic models. Use `.model_dump()` to convert to `dict` when needed.
+
+### Configuration & Settings
+
+The client uses a deterministic cascade to resolve configuration:
+
+1. Library defaults (built‑in constants)
+2. `config.json` (first existing among: `$TEMPEST_CONFIG_PATH`, `./config.json`)
+3. `.env` file (loaded automatically once, without overriding already exported environment vars)
+4. Live environment variables (take precedence over `.env` values)
+5. Explicit parameters passed to `Tempest(...)` (highest precedence)
+
+Resolved values are materialized into an immutable `Settings` instance:
+
+```python
+from tempestwx.settings_loader import load_settings
+settings = load_settings()
+print(settings.api_uri, settings.token)
+```
+
+You can explicitly override when constructing the client:
+
+```python
+from tempestwx import Tempest
+
+with Tempest(token="OVERRIDE_TOKEN") as twx:
+    stations = twx.stations()
+```
+
+Or derive a modified settings object:
+
+```python
+from tempestwx.settings_loader import load_settings
+
+base = load_settings()
+custom = base.with_overrides(api_uri="https://example.test/api/")
+
+with Tempest(settings=custom) as twx:
+    stations = twx.stations()
+```
+
+### Environment Variables
+
+Supported variables:
+
+- `TEMPEST_ACCESS_TOKEN` – API auth token
+- `TEMPEST_API_URI` – Base API URI (defaults to `https://swd.weatherflow.com/swd/rest/`)
+- `TEMPEST_CONFIG_PATH` – Optional path to a JSON config file (fallbacks to `./config.json`)
+- Unit overrides (optional):
+  - `TEMPEST_DEFAULT_UNIT_TEMPERATURE`
+  - `TEMPEST_DEFAULT_UNIT_PRESSURE`
+  - `TEMPEST_DEFAULT_UNIT_WIND`
+  - `TEMPEST_DEFAULT_UNIT_DISTANCE`
+  - `TEMPEST_DEFAULT_UNIT_PRECIP`
+  - `TEMPEST_DEFAULT_UNIT_BRIGHTNESS`
+  - `TEMPEST_DEFAULT_UNIT_SOLAR_RADIATION`
+  - `TEMPEST_DEFAULT_UNIT_BUCKET_STEP_MINUTES`
+
+### .env Support
+
+If a `.env` file exists in the working directory, it is loaded automatically (without overriding already exported variables) the first time `load_settings()` runs.
+
+Example `.env`:
+
+```dotenv
+TEMPEST_ACCESS_TOKEN=your-token-here
+```
+
+### config.json example
+
+If present, values provide defaults that can be overridden by environment variables:
+
+```json
+{
+  "api_uri": "https://swd.weatherflow.com/swd/rest/",
+  "default_unit_temperature": "c",
+  "default_unit_pressure": "mb",
+  "default_unit_wind": "mps",
+  "default_unit_distance": "km",
+  "default_units_precip": "mm",
+  "default_units_brightness": "lux",
+  "default_units_solar_radiation": "w/m2",
+  "default_units_bucket_step_minutes": 1
+}
+```
+
+Note: tokens are not read from `config.json`. Use environment variables or `.env` for `TEMPEST_ACCESS_TOKEN`.
+
+### Reloading Settings
+
+Caching avoids repeated disk & env parsing. To pick up changes at runtime:
+
+```python
+from tempestwx.settings_loader import reload_settings
+reload_settings()  # clears cache and re-evaluates cascade
+```
+
+### Units Overrides
+
+You can supply partial unit overrides via `UnitsOverrides` (only fields you specify are changed):
+
+```python
+from tempestwx import Tempest
+from tempestwx.settings import UnitsOverrides
+from tempestwx.settings_loader import load_settings
+
+base = load_settings()
+custom = base.with_overrides(units_overrides=UnitsOverrides(temp="f", wind="mph"))
+
+with Tempest(settings=custom) as twx:
+    forecast = twx.better_forecast(station_id=12345)
+```
+
+### Token Context Override
+
+Temporarily swap tokens within a context:
+
+```python
+from tempestwx import Tempest
+
+with Tempest() as twx:
+    # Use default token
+    stations = twx.stations()
+
+    # Temporarily use different token
+    with twx.token_as("temporary-token"):
+        other_stations = twx.stations()
+
+    # Back to default token
+    more_stations = twx.stations()
+```
+
+### Async Usage
+
+All endpoints support async when the client is created with `asynchronous=True`:
+
+```python
+import asyncio
+from tempestwx import Tempest
+
+async def main():
+    # Use async context manager for proper cleanup
+    async with Tempest(asynchronous=True) as twx:
+        stations = await twx.stations()
+        print(stations)
+
+asyncio.run(main())
+```
+
+## Roadmap
+
+- OAuth Authorization Code (with PKCE) grant types
+- Additional Tempest APIs, e.g. TempestOne
+- Standalone documentation with MkDocs