wxbrief 0.4.0__tar.gz

wxbrief-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bill Kane
+
+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.

wxbrief-0.4.0/PKG-INFO

@@ -0,0 +1,185 @@
+Metadata-Version: 2.4
+Name: wxbrief
+Version: 0.4.0
+Summary: Terminal METAR/TAF briefing with colorways and plain-language translation
+Author: Bill Kane
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/WPTK/wxbrief
+Project-URL: Issues, https://github.com/WPTK/wxbrief/issues
+Project-URL: Changelog, https://github.com/WPTK/wxbrief/blob/main/CHANGELOG.md
+Keywords: metar,taf,aviation,weather,tui,terminal,textual
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: textual<9,>=8.2
+Requires-Dist: httpx<1,>=0.28
+Requires-Dist: hishel[async]<2,>=1.4
+Requires-Dist: anysqlite<1,>=0.0.5
+Requires-Dist: stamina<27,>=26
+Requires-Dist: platformdirs<5,>=4
+Requires-Dist: tomli-w<2,>=1
+Requires-Dist: pyperclip<2,>=1.9
+Requires-Dist: tzdata; sys_platform == "win32"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24; extra == "dev"
+Requires-Dist: respx>=0.22; extra == "dev"
+Requires-Dist: pytest-xdist>=3.6; extra == "dev"
+Requires-Dist: pytest-timeout>=2.3; extra == "dev"
+Requires-Dist: psutil>=6; extra == "dev"
+Requires-Dist: pytest-cov>=5; extra == "dev"
+Requires-Dist: hypothesis>=6; extra == "dev"
+Requires-Dist: pytest-textual-snapshot==1.1.*; extra == "dev"
+Requires-Dist: timezonefinder<10,>=9; extra == "dev"
+Requires-Dist: pyinstaller<7,>=6.22; extra == "dev"
+Requires-Dist: build<2,>=1; extra == "dev"
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: pillow>=10; extra == "dev"
+Requires-Dist: vulture>=2.14; extra == "dev"
+Requires-Dist: mypy>=1.13; extra == "dev"
+Requires-Dist: types-pyperclip; extra == "dev"
+Requires-Dist: tui-test==0.1.1; extra == "dev"
+Provides-Extra: binary
+Requires-Dist: tzdata>=2024.1; extra == "binary"
+Dynamic: license-file
+
+# wxbrief
+
+[![CI](https://github.com/WPTK/wxbrief/actions/workflows/ci.yml/badge.svg)](https://github.com/WPTK/wxbrief/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+A terminal app for reading METARs and TAFs. It fetches the reports from aviationweather.gov, decodes them with its own
+parser, and shows each station with the raw report, a plain-language translation and a TAF timeline. The colours are
+switchable, and the text is available in English, Spanish, French, German and Portuguese.
+
+![wxbrief on its bundled demo reports: the station list, decoded METAR, TAF timeline, grid layout and a colorway change](docs/img/demo.gif)
+
+*Recorded from the real app running on its bundled `--demo` reports (fixed demo data, not live weather).*
+
+![Station list on the left, the decoded METAR and the start of the TAF on the right](docs/img/briefing.png)
+
+Version 0.4.0. The project uses ZeroVer, so the version stays 0.x and anything may still change.
+
+## What it does
+
+- Watches a list of stations and refreshes their METAR/SPECI and TAF reports within a polling budget that stays under
+  the AWC rate limit. Reports are cached on disk.
+- Decodes the body, trends, remarks (including colour states, runway state, wind shear and sea state) and TAF change
+  groups. Anything it cannot decode is shown as it was reported, not guessed.
+- Shows a TAF timeline per station. A cursor moves through the periods and the period under it is decoded below.
+- Has a list layout and a grid layout (`v` switches), and works down to 60 columns by 16 rows.
+- Offers 18 colorways (`t` cycles them, `T` opens a picker with live preview). See [docs/themes.md](docs/themes.md).
+- Decodes pasted reports offline (`p`).
+- Copies a report as a Discord code block (`c`), or prints one from the command line.
+- Prints plain text or JSON from the `decode` and `get` commands.
+- Runs with no network at all in `--demo` mode, on ten bundled stations.
+
+## What wxbrief is not
+
+wxbrief is not a substitute for an official weather briefing, and not for flight planning alone. Get an official briefing
+before you fly. The same notice is in `wxbrief --help` and the in-app help (`?`).
+
+![The TAF timeline with the cursor on the first period, in paper-chart](docs/img/forecast.png)
+
+![The grid layout: one card per station with a small forecast strip](docs/img/grid.png)
+
+## Install
+
+There is no PyPI package. Each [release](https://github.com/WPTK/wxbrief/releases) has these files:
+
+| File | For |
+| --- | --- |
+| `wxbrief-0.4.0-windows-x86_64.exe` | Windows, no Python needed |
+| `wxbrief-0.4.0-linux-x86_64.tar.gz`, `wxbrief-0.4.0-linux-arm64.tar.gz` | Linux; the archive holds one `wxbrief` executable |
+| `wxbrief-0.4.0-macos-arm64.tar.gz`, `wxbrief-0.4.0-macos-x86_64.tar.gz` | macOS; the archive holds one `wxbrief` executable |
+| `wxbrief-0.4.0-py3-none-any.whl` | any platform with Python 3.12 or newer: `pip install wxbrief-0.4.0-py3-none-any.whl` |
+| `SHA256SUMS` | checking the downloads; each file also has a build provenance attestation |
+
+To run from source instead, you need Python 3.12 or newer:
+
+```sh
+git clone https://github.com/WPTK/wxbrief.git
+cd wxbrief
+python -m venv .venv
+.venv/bin/python -m pip install -e .
+.venv/bin/wxbrief --version
+```
+
+On Windows the venv paths are `.venv\Scripts\python` and `.venv\Scripts\wxbrief`. The commands below assume `wxbrief` is
+on your path; otherwise use `python -m wxbrief`.
+
+## Usage
+
+```sh
+wxbrief --demo              # ten bundled stations, offline
+wxbrief KDEN EGLL ETHB      # watch these stations for this run
+wxbrief                     # your saved stations
+```
+
+Press `?` in the app for the keys. The main ones:
+
+| Key | Does |
+| --- | --- |
+| `a`, `d` | add or remove a station (by ICAO, IATA or FAA code or by name) |
+| `r` | refresh |
+| `v` | list or grid |
+| `1` `2` `3` | raw, decoded and forecast sections |
+| `p` | paste METARs or TAFs and decode them |
+| `c` | copy the report as a Discord block |
+| `t`, `T` | next colorway, colorway picker |
+| `g`, `u`, `z` | glyph set, units, time mode (station, local, zulu) |
+| `S` | settings, including the language |
+| `q` | quit |
+
+Settings you change in the app are saved to `config.toml` in your user config folder. A command-line flag such as
+`--theme`, `--glyphs`, `--units`, `--time` or `--lang` applies to that run only and is never saved. `--no-config`
+reads and writes no config file. `WXBRIEF_CACHE_DIR` moves the cache folder. `wxbrief --help` lists every flag.
+
+Stations given on the command line or in the config are passed through as typed. A station that the bundled database
+does not know can still be watched; it just has no name or time zone.
+
+### Without the interface
+
+```sh
+wxbrief decode "METAR KDEN 131453Z 06007KT 3/4SM BR OVC003 09/08 A3001"
+wxbrief get KDEN EGLL --plain
+echo "METAR KDEN 131453Z 06007KT 3/4SM BR OVC003 09/08 A3001" | wxbrief decode --lang de
+```
+
+`decode` reads reports from the arguments or from standard input, including several reports in one blob, and prints
+them with colour, or with `--plain`, `--json` or `--discord`. `--lang`, `--units` and `--date` change the language, the
+unit order and the date used to resolve the day of the month. `get` fetches the latest reports for the given stations
+once and takes the same output flags. `decode` and `get` never read the config file.
+
+## Data
+
+Reports come from the [Aviation Weather Center](https://aviationweather.gov/) data API. The demo reports are bundled
+with the program.
+
+The client follows the [API usage guidance](https://aviationweather.gov/data/api/): it identifies itself with a
+`User-Agent` naming wxbrief, its version and this repository, polls METARs every 10 minutes and TAFs every 30, stays
+under 100 requests a minute, honours `Retry-After` on a 429, and asks the server whether a report has changed when it
+sends `ETag` or `Last-Modified`, and reuses the stored one only on a 304. It never reuses a response on its own. A request that fails in transit or with a 5xx is tried up to three
+times, waiting a doubling, randomly jittered time between tries.
+
+The bundled station database (`wxbrief/data/stations.json.gz`) takes station positions from the AWC station list and
+assigns each station its IANA time zone with [timezonefinder](https://github.com/jannikmi/timezonefinder), which uses
+the [timezone-boundary-builder](https://github.com/evansiroky/timezone-boundary-builder) data. That data is
+© OpenStreetMap contributors and is available under the
+[Open Database License (ODbL) 1.0](https://opendatacommons.org/licenses/odbl/1-0/). The `tz` column of the station
+database is a database derived from it and is shared under the same licence; the rest of wxbrief is MIT.
+
+wxbrief is a reading aid. Do not use it as the only source for a flight decision.
+
+## More
+
+- [docs/themes.md](docs/themes.md): the colorways and how the weather colours are chosen.
+- [docs/i18n.md](docs/i18n.md): languages, and how to add or fix a translation.
+- [docs/decoding.md](docs/decoding.md): how the decoder works and how to add a test report.
+- [docs/development.md](docs/development.md): setup, checks, tests, snapshots and screenshots.
+- [docs/release.md](docs/release.md): cutting a release.
+- [CONTRIBUTING.md](CONTRIBUTING.md), [SECURITY.md](SECURITY.md), [CHANGELOG.md](CHANGELOG.md).
+
+## License
+
+MIT, see [LICENSE](LICENSE).

wxbrief-0.4.0/README.md

@@ -0,0 +1,140 @@
+# wxbrief
+
+[![CI](https://github.com/WPTK/wxbrief/actions/workflows/ci.yml/badge.svg)](https://github.com/WPTK/wxbrief/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+A terminal app for reading METARs and TAFs. It fetches the reports from aviationweather.gov, decodes them with its own
+parser, and shows each station with the raw report, a plain-language translation and a TAF timeline. The colours are
+switchable, and the text is available in English, Spanish, French, German and Portuguese.
+
+![wxbrief on its bundled demo reports: the station list, decoded METAR, TAF timeline, grid layout and a colorway change](docs/img/demo.gif)
+
+*Recorded from the real app running on its bundled `--demo` reports (fixed demo data, not live weather).*
+
+![Station list on the left, the decoded METAR and the start of the TAF on the right](docs/img/briefing.png)
+
+Version 0.4.0. The project uses ZeroVer, so the version stays 0.x and anything may still change.
+
+## What it does
+
+- Watches a list of stations and refreshes their METAR/SPECI and TAF reports within a polling budget that stays under
+  the AWC rate limit. Reports are cached on disk.
+- Decodes the body, trends, remarks (including colour states, runway state, wind shear and sea state) and TAF change
+  groups. Anything it cannot decode is shown as it was reported, not guessed.
+- Shows a TAF timeline per station. A cursor moves through the periods and the period under it is decoded below.
+- Has a list layout and a grid layout (`v` switches), and works down to 60 columns by 16 rows.
+- Offers 18 colorways (`t` cycles them, `T` opens a picker with live preview). See [docs/themes.md](docs/themes.md).
+- Decodes pasted reports offline (`p`).
+- Copies a report as a Discord code block (`c`), or prints one from the command line.
+- Prints plain text or JSON from the `decode` and `get` commands.
+- Runs with no network at all in `--demo` mode, on ten bundled stations.
+
+## What wxbrief is not
+
+wxbrief is not a substitute for an official weather briefing, and not for flight planning alone. Get an official briefing
+before you fly. The same notice is in `wxbrief --help` and the in-app help (`?`).
+
+![The TAF timeline with the cursor on the first period, in paper-chart](docs/img/forecast.png)
+
+![The grid layout: one card per station with a small forecast strip](docs/img/grid.png)
+
+## Install
+
+There is no PyPI package. Each [release](https://github.com/WPTK/wxbrief/releases) has these files:
+
+| File | For |
+| --- | --- |
+| `wxbrief-0.4.0-windows-x86_64.exe` | Windows, no Python needed |
+| `wxbrief-0.4.0-linux-x86_64.tar.gz`, `wxbrief-0.4.0-linux-arm64.tar.gz` | Linux; the archive holds one `wxbrief` executable |
+| `wxbrief-0.4.0-macos-arm64.tar.gz`, `wxbrief-0.4.0-macos-x86_64.tar.gz` | macOS; the archive holds one `wxbrief` executable |
+| `wxbrief-0.4.0-py3-none-any.whl` | any platform with Python 3.12 or newer: `pip install wxbrief-0.4.0-py3-none-any.whl` |
+| `SHA256SUMS` | checking the downloads; each file also has a build provenance attestation |
+
+To run from source instead, you need Python 3.12 or newer:
+
+```sh
+git clone https://github.com/WPTK/wxbrief.git
+cd wxbrief
+python -m venv .venv
+.venv/bin/python -m pip install -e .
+.venv/bin/wxbrief --version
+```
+
+On Windows the venv paths are `.venv\Scripts\python` and `.venv\Scripts\wxbrief`. The commands below assume `wxbrief` is
+on your path; otherwise use `python -m wxbrief`.
+
+## Usage
+
+```sh
+wxbrief --demo              # ten bundled stations, offline
+wxbrief KDEN EGLL ETHB      # watch these stations for this run
+wxbrief                     # your saved stations
+```
+
+Press `?` in the app for the keys. The main ones:
+
+| Key | Does |
+| --- | --- |
+| `a`, `d` | add or remove a station (by ICAO, IATA or FAA code or by name) |
+| `r` | refresh |
+| `v` | list or grid |
+| `1` `2` `3` | raw, decoded and forecast sections |
+| `p` | paste METARs or TAFs and decode them |
+| `c` | copy the report as a Discord block |
+| `t`, `T` | next colorway, colorway picker |
+| `g`, `u`, `z` | glyph set, units, time mode (station, local, zulu) |
+| `S` | settings, including the language |
+| `q` | quit |
+
+Settings you change in the app are saved to `config.toml` in your user config folder. A command-line flag such as
+`--theme`, `--glyphs`, `--units`, `--time` or `--lang` applies to that run only and is never saved. `--no-config`
+reads and writes no config file. `WXBRIEF_CACHE_DIR` moves the cache folder. `wxbrief --help` lists every flag.
+
+Stations given on the command line or in the config are passed through as typed. A station that the bundled database
+does not know can still be watched; it just has no name or time zone.
+
+### Without the interface
+
+```sh
+wxbrief decode "METAR KDEN 131453Z 06007KT 3/4SM BR OVC003 09/08 A3001"
+wxbrief get KDEN EGLL --plain
+echo "METAR KDEN 131453Z 06007KT 3/4SM BR OVC003 09/08 A3001" | wxbrief decode --lang de
+```
+
+`decode` reads reports from the arguments or from standard input, including several reports in one blob, and prints
+them with colour, or with `--plain`, `--json` or `--discord`. `--lang`, `--units` and `--date` change the language, the
+unit order and the date used to resolve the day of the month. `get` fetches the latest reports for the given stations
+once and takes the same output flags. `decode` and `get` never read the config file.
+
+## Data
+
+Reports come from the [Aviation Weather Center](https://aviationweather.gov/) data API. The demo reports are bundled
+with the program.
+
+The client follows the [API usage guidance](https://aviationweather.gov/data/api/): it identifies itself with a
+`User-Agent` naming wxbrief, its version and this repository, polls METARs every 10 minutes and TAFs every 30, stays
+under 100 requests a minute, honours `Retry-After` on a 429, and asks the server whether a report has changed when it
+sends `ETag` or `Last-Modified`, and reuses the stored one only on a 304. It never reuses a response on its own. A request that fails in transit or with a 5xx is tried up to three
+times, waiting a doubling, randomly jittered time between tries.
+
+The bundled station database (`wxbrief/data/stations.json.gz`) takes station positions from the AWC station list and
+assigns each station its IANA time zone with [timezonefinder](https://github.com/jannikmi/timezonefinder), which uses
+the [timezone-boundary-builder](https://github.com/evansiroky/timezone-boundary-builder) data. That data is
+© OpenStreetMap contributors and is available under the
+[Open Database License (ODbL) 1.0](https://opendatacommons.org/licenses/odbl/1-0/). The `tz` column of the station
+database is a database derived from it and is shared under the same licence; the rest of wxbrief is MIT.
+
+wxbrief is a reading aid. Do not use it as the only source for a flight decision.
+
+## More
+
+- [docs/themes.md](docs/themes.md): the colorways and how the weather colours are chosen.
+- [docs/i18n.md](docs/i18n.md): languages, and how to add or fix a translation.
+- [docs/decoding.md](docs/decoding.md): how the decoder works and how to add a test report.
+- [docs/development.md](docs/development.md): setup, checks, tests, snapshots and screenshots.
+- [docs/release.md](docs/release.md): cutting a release.
+- [CONTRIBUTING.md](CONTRIBUTING.md), [SECURITY.md](SECURITY.md), [CHANGELOG.md](CHANGELOG.md).
+
+## License
+
+MIT, see [LICENSE](LICENSE).

wxbrief-0.4.0/pyproject.toml

@@ -0,0 +1,119 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "wxbrief"
+dynamic = ["version"]
+description = "Terminal METAR/TAF briefing with colorways and plain-language translation"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.12"
+authors = [{ name = "Bill Kane" }]
+keywords = ["metar", "taf", "aviation", "weather", "tui", "terminal", "textual"]
+
+dependencies = [
+    "textual>=8.2,<9",
+    "httpx>=0.28,<1",
+    "hishel[async]>=1.4,<2",
+    "anysqlite>=0.0.5,<1",
+    "stamina>=26,<27",
+    "platformdirs>=4,<5",
+    "tomli-w>=1,<2",
+    "pyperclip>=1.9,<2",
+    "tzdata; sys_platform == 'win32'",
+]
+
+[project.urls]
+Homepage = "https://github.com/WPTK/wxbrief"
+Issues = "https://github.com/WPTK/wxbrief/issues"
+Changelog = "https://github.com/WPTK/wxbrief/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8",
+    "pytest-asyncio>=0.24",
+    "respx>=0.22",
+    "pytest-xdist>=3.6",
+    "pytest-timeout>=2.3",
+    "psutil>=6",
+    "pytest-cov>=5",
+    "hypothesis>=6",
+    "pytest-textual-snapshot==1.1.*",
+    "timezonefinder>=9,<10",
+    "pyinstaller>=6.22,<7",
+    "build>=1,<2",
+    "ruff>=0.8",
+    "pillow>=10",
+    "vulture>=2.14",
+    "mypy>=1.13",
+    "types-pyperclip",
+    "tui-test==0.1.1",
+]
+# Installed only when building a standalone binary, so every binary carries its own zone files.
+binary = ["tzdata>=2024.1"]
+
+[project.scripts]
+wxbrief = "wxbrief.__main__:main"
+
+[tool.setuptools.dynamic]
+version = { attr = "wxbrief.__version__" }
+
+[tool.setuptools.packages.find]
+include = ["wxbrief*"]
+
+[tool.setuptools.package-data]
+wxbrief = [
+    "ui/*.tcss",
+    "data/stations.json.gz",
+    "data/demo/*.txt",
+    "i18n/locales/*.toml",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+testpaths = ["tests"]
+# A test that has not finished in two minutes is hung. The slowest test in the suite takes a few seconds.
+timeout = 120
+timeout_method = "thread"
+markers = [
+    "pty: real-terminal journeys (pseudo-terminal + pyte); skipped when the PTY layer is unavailable",
+    "slow: UAT journeys that take several seconds (deselect with -m \"not slow\")"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "SIM", "C4", "RUF"]
+ignore = [
+    # Textual widgets declare BINDINGS/DEFAULT_CSS as plain class attributes by convention.
+    "RUF012",
+]
+
+[tool.ruff.lint.per-file-ignores]
+# Long lines in tests are inline report fixtures; wrapping them hurts readability.
+"tests/**" = ["E501"]
+
+[tool.mypy]
+python_version = "3.12"
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+check_untyped_defs = true
+
+# The decoder and the translation layer are typed end to end: the per-module flags that make up `--strict`.
+# (`strict = true` inside an override is applied to every module by mypy, so the flags are spelled out.)
+[[tool.mypy.overrides]]
+module = ["wxbrief.decode.*", "wxbrief.i18n.*", "wxbrief.calc.*"]
+disallow_any_generics = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+disallow_untyped_decorators = true
+warn_return_any = true
+implicit_reexport = false
+strict_equality = true
+extra_checks = true

wxbrief-0.4.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+