pgntui 0.2.0__tar.gz → 0.2.2__tar.gz

{pgntui-0.2.0 → pgntui-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pgntui
-Version: 0.2.0
+Version: 0.2.2
 Summary: Cross-platform TUI for NMEA 2000 with canboat decoding and pluggable drivers
 Author: phobicdotno
 License: MIT License

{pgntui-0.2.0 → pgntui-0.2.2}/packaging/homebrew/pgntui.rb

@@ -3,7 +3,7 @@
 class Pgntui < Formula
   desc "Cross-platform TUI for NMEA 2000 with canboat decoding"
   homepage "https://github.com/phobicdotno/pgntui"
-  url "https://files.pythonhosted.org/packages/source/p/pgntui/pgntui-0.2.0.tar.gz"
+  url "https://files.pythonhosted.org/packages/source/p/pgntui/pgntui-0.2.2.tar.gz"
   sha256 "REPLACE_ON_RELEASE"
   license "MIT"
 

{pgntui-0.2.0 → pgntui-0.2.2}/packaging/winget/phobic.pgntui.yaml

@@ -1,6 +1,6 @@
 # Stub manifest for microsoft/winget-pkgs PR
 PackageIdentifier: phobic.pgntui
-PackageVersion: 0.2.0
+PackageVersion: 0.2.2
 PackageLocale: en-US
 Publisher: phobic
 PackageName: pgntui
@@ -15,7 +15,7 @@ Tags: [nmea, marine, tui, terminal]
 Installers:
   - Architecture: x64
     InstallerType: portable
-    InstallerUrl: https://github.com/phobicdotno/pgntui/releases/download/v0.2.0/pgntui-windows-x86_64.exe
+    InstallerUrl: https://github.com/phobicdotno/pgntui/releases/download/v0.2.2/pgntui-windows-x86_64.exe
     InstallerSha256: REPLACE_ON_RELEASE
 ManifestType: singleton
 ManifestVersion: 1.6.0

{pgntui-0.2.0 → pgntui-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pgntui"
-version = "0.2.0"
+version = "0.2.2"
 description = "Cross-platform TUI for NMEA 2000 with canboat decoding and pluggable drivers"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -64,6 +64,9 @@ packages = ["src/pgntui"]
 "src/pgntui/examples/signals/speed.json" = "pgntui/examples/signals/speed.json"
 "src/pgntui/examples/signals/depth.json" = "pgntui/examples/signals/depth.json"
 "src/pgntui/examples/signals/water_temp.json" = "pgntui/examples/signals/water_temp.json"
+"src/pgntui/examples/signals/target_heading.json" = "pgntui/examples/signals/target_heading.json"
+"src/pgntui/examples/signals/bilge_alarm.json" = "pgntui/examples/signals/bilge_alarm.json"
+"src/pgntui/examples/signals/anchor_light.json" = "pgntui/examples/signals/anchor_light.json"
 
 [tool.ruff]
 line-length = 100

{pgntui-0.2.0 → pgntui-0.2.2}/src/pgntui/__init__.py

@@ -1,3 +1,3 @@
 """pgntui — NMEA 2000 TUI."""
 
-__version__ = "0.2.0"
+__version__ = "0.2.2"

{pgntui-0.2.0 → pgntui-0.2.2}/src/pgntui/app.py

@@ -52,14 +52,19 @@ class PgntuiApp(App[None]):
     serial waits) never stall the UI event loop.
     """
 
-    CSS = ""
+    CSS = """
+    TabbedContent { height: 1fr; }
+    #hotkey-strip { height: 1; dock: bottom; background: $primary; }
+    #status-bar { height: 1; dock: bottom; }
+    #welcome { padding: 1 2; }
+    """
 
     BINDINGS = [
         ("tab", "next_container", "Next"),
         ("shift+tab", "prev_container", "Prev"),
         ("d", "show_debug", "Debug"),
         ("r", "toggle_record", "Record"),
-        ("q", "quit", "Quit"),
+        ("q,ctrl+q", "force_quit", "Quit"),
         ("question_mark", "help", "Help"),
     ]
 
@@ -129,12 +134,18 @@ class PgntuiApp(App[None]):
                             self._views.append((container, view))
                             yield view
                 with TabPane("Debug", id="debug"):
+                    if not self._containers and self._container_titles is None:
+                        yield Static(_WELCOME_TEXT, id="welcome", markup=True)
                     self._debug_log = DebugLog(
                         highlight=False, markup=False, wrap=False, id="debug-log"
                     )
                     yield self._debug_log
-            yield Static("[Tab] Next [D] Debug [R] Rec [Q] Quit", id="hotkey-strip")
-            yield Static("status: idle", id="status-bar")
+            yield Static(
+                "[Tab] Next [D] Debug [R] Rec [Q] Quit",
+                id="hotkey-strip",
+                markup=False,
+            )
+            yield Static("status: idle", id="status-bar", markup=False)
 
     @property
     def _views(self) -> list[tuple[Container, ContainerView]]:
@@ -301,6 +312,29 @@ class PgntuiApp(App[None]):
     def action_help(self) -> None:
         self._set_status("help: Tab/D/R/Q")
 
+    def action_force_quit(self) -> None:
+        """Quit immediately, bypassing Textual's ctrl+q confirmation toast."""
+        # Make sure recording is flushed cleanly before we exit.
+        if self._writer is not None:
+            try:
+                self._stop_recording()
+            except Exception:  # pragma: no cover — defensive
+                pass
+        self.exit()
+
+
+_WELCOME_TEXT = """[b]pgntui[/b] — no workspace configured
+
+To get started:
+  [b]pgntui --example[/b]            scaffold an example workspace at ~/.config/pgntui/
+  [b]pgntui replay <file.pgnlog>[/b]  play a recording into the TUI
+  [b]pgntui --help[/b]               full options
+
+Once a workspace exists, container tabs will appear above and incoming PGN
+frames will scroll here.
+
+Press [b]Q[/b] to quit."""
+
 
 def _encode_analog_payload(value: float) -> bytes:
     """Minimal encoder used by the analog write callback.

pgntui-0.2.2/src/pgntui/examples/containers/main.json

@@ -0,0 +1,14 @@
+{
+  "id": "main",
+  "title": "Main",
+  "cols": 12,
+  "signals": [
+    {"ref": "engine_rpm",     "row": 0, "col": 0,  "w": 3},
+    {"ref": "speed",          "row": 0, "col": 3,  "w": 3},
+    {"ref": "depth",          "row": 0, "col": 6,  "w": 3},
+    {"ref": "water_temp",     "row": 0, "col": 9,  "w": 3},
+    {"ref": "target_heading", "row": 1, "col": 0,  "w": 12},
+    {"ref": "bilge_alarm",    "row": 2, "col": 0,  "w": 6},
+    {"ref": "anchor_light",   "row": 2, "col": 6,  "w": 6}
+  ]
+}

pgntui-0.2.2/src/pgntui/examples/signals/anchor_light.json

@@ -0,0 +1,12 @@
+{
+  "id": "anchor_light",
+  "type": "digital_out",
+  "title": "Anchor Light",
+  "pgn": 127502,
+  "field": "Switch1",
+  "on_label": "ON",
+  "off_label": "OFF",
+  "write_pgn": 127502,
+  "write_field": "Switch1",
+  "log": false
+}

pgntui-0.2.2/src/pgntui/examples/signals/bilge_alarm.json

@@ -0,0 +1,10 @@
+{
+  "id": "bilge_alarm",
+  "type": "digital_in",
+  "title": "Bilge Alarm",
+  "pgn": 127501,
+  "field": "Indicator1",
+  "on_label": "WET",
+  "off_label": "DRY",
+  "log": true
+}

pgntui-0.2.2/src/pgntui/examples/signals/target_heading.json

@@ -0,0 +1,14 @@
+{
+  "id": "target_heading",
+  "type": "analog_out",
+  "title": "Target Heading",
+  "unit": "rad",
+  "pgn": 65360,
+  "field": "Target Heading Magnetic",
+  "min": 0,
+  "max": 6.2832,
+  "decimals": 2,
+  "write_pgn": 65360,
+  "write_field": "Target Heading Magnetic",
+  "log": false
+}

pgntui-0.2.2/tests/test_app_empty_welcome.py

@@ -0,0 +1,50 @@
+"""Empty-workspace welcome panel is shown in the Debug tab when no containers exist."""
+
+from __future__ import annotations
+
+import pytest
+from textual.widgets import Static
+
+from pgntui.app import PgntuiApp
+from pgntui.themes.loader import load_builtin
+
+
+@pytest.mark.asyncio
+async def test_empty_workspace_shows_welcome_panel() -> None:
+    app = PgntuiApp(theme=load_builtin("dark"), containers=[])
+    async with app.run_test() as pilot:
+        await pilot.pause()
+        welcome = app.query_one("#welcome", Static)
+        assert welcome is not None
+        # The welcome blurb must point the user at --example to scaffold a workspace.
+        rendered = str(welcome.render())
+        assert "pgntui --example" in rendered
+        assert "pgntui" in rendered
+
+
+@pytest.mark.asyncio
+async def test_welcome_panel_hidden_when_containers_are_present() -> None:
+    """With at least one container, the welcome panel must not appear — the user
+    already has a working workspace."""
+    app = PgntuiApp(theme=load_builtin("dark"), container_titles=["Engine"])
+    async with app.run_test() as pilot:
+        await pilot.pause()
+        # query() returns DOMQuery — len == 0 means not mounted.
+        assert len(app.query("#welcome")) == 0
+
+
+@pytest.mark.asyncio
+async def test_bottom_strips_visible_on_empty_workspace() -> None:
+    """Hotkey strip and status bar must still be reachable when the workspace is
+    empty (the original bug had TabbedContent absorbing all vertical space)."""
+    app = PgntuiApp(theme=load_builtin("dark"), containers=[])
+    async with app.run_test() as pilot:
+        await pilot.pause()
+        hotkeys = app.query_one("#hotkey-strip", Static)
+        status = app.query_one("#status-bar", Static)
+        assert hotkeys is not None
+        assert status is not None
+        # Sanity: hotkey strip text matches the actual bindings.
+        rendered = str(hotkeys.render())
+        assert "[Tab]" in rendered
+        assert "[Q]" in rendered

pgntui-0.2.2/tests/test_app_quit_binding.py

@@ -0,0 +1,51 @@
+"""Pressing q quits immediately (no Textual confirmation toast)."""
+
+from __future__ import annotations
+
+import pytest
+
+from pgntui.app import PgntuiApp
+from pgntui.themes.loader import load_builtin
+
+
+@pytest.mark.asyncio
+async def test_q_key_quits_app_immediately() -> None:
+    app = PgntuiApp(theme=load_builtin("dark"), containers=[])
+    async with app.run_test() as pilot:
+        await pilot.pause()
+        assert app.is_running
+        await pilot.press("q")
+        # Give the action loop a beat to process the exit.
+        for _ in range(5):
+            await pilot.pause()
+            if not app.is_running:
+                break
+    assert not app.is_running
+
+
+@pytest.mark.asyncio
+async def test_ctrl_q_key_also_quits_app() -> None:
+    app = PgntuiApp(theme=load_builtin("dark"), containers=[])
+    async with app.run_test() as pilot:
+        await pilot.pause()
+        assert app.is_running
+        await pilot.press("ctrl+q")
+        for _ in range(5):
+            await pilot.pause()
+            if not app.is_running:
+                break
+    assert not app.is_running
+
+
+@pytest.mark.asyncio
+async def test_force_quit_action_directly() -> None:
+    """The action_force_quit method should bypass any quit confirmation."""
+    app = PgntuiApp(theme=load_builtin("dark"), containers=[])
+    async with app.run_test() as pilot:
+        await pilot.pause()
+        app.action_force_quit()
+        for _ in range(5):
+            await pilot.pause()
+            if not app.is_running:
+                break
+    assert not app.is_running

{pgntui-0.2.0 → pgntui-0.2.2}/tests/test_example_workspace.py

@@ -6,7 +6,7 @@ from pathlib import Path
 
 from pgntui.__main__ import main
 from pgntui.containers.loader import load_container
-from pgntui.signals.base import load_signals_dir
+from pgntui.signals.base import AnalogIn, AnalogOut, DigitalIn, DigitalOut, load_signals_dir
 
 
 def test_example_creates_expected_files(tmp_path: Path) -> None:
@@ -18,8 +18,17 @@ def test_example_creates_expected_files(tmp_path: Path) -> None:
     assert (ws / "containers").is_dir()
     signals = load_signals_dir(ws / "signals")
     ids = {s.id for s in signals}
-    # We ship four sensible defaults.
-    assert ids == {"engine_rpm", "speed", "depth", "water_temp"}
+    # Seven shipped defaults: four analog readouts plus one of each remaining
+    # widget kind so the scaffold exercises the full UI surface.
+    assert ids == {
+        "engine_rpm",
+        "speed",
+        "depth",
+        "water_temp",
+        "target_heading",
+        "bilge_alarm",
+        "anchor_light",
+    }
     # Containers reference signal ids that exist.
     main_container = load_container(ws / "containers" / "main.json", ids)
     refs = {p.ref for p in main_container.signals}
@@ -27,6 +36,19 @@ def test_example_creates_expected_files(tmp_path: Path) -> None:
     assert main_container.cols == 12
 
 
+def test_example_includes_all_four_widget_types(tmp_path: Path) -> None:
+    """Scaffolded workspace must contain at least one signal of each kind."""
+    ws = tmp_path / "ws"
+    rc = main(["--workspace", str(ws), "--example"])
+    assert rc == 0
+    signals = load_signals_dir(ws / "signals")
+    kinds = {type(s) for s in signals}
+    assert AnalogIn in kinds
+    assert AnalogOut in kinds
+    assert DigitalIn in kinds
+    assert DigitalOut in kinds
+
+
 def test_example_refuses_when_workspace_non_empty(tmp_path: Path, capsys) -> None:  # type: ignore[no-untyped-def]
     ws = tmp_path / "ws"
     ws.mkdir()

{pgntui-0.2.0 → pgntui-0.2.2}/tests/test_signals_loader.py

@@ -6,28 +6,38 @@ from importlib import resources
 
 import pytest
 
-from pgntui.signals.base import AnalogIn, AnalogOut, DigitalIn, DigitalOut, load_signal
+from pgntui.signals.base import AnalogIn, AnalogOut, DigitalIn, DigitalOut, Signal, load_signal
 
+_EXAMPLE_EXPECTED: dict[str, type[Signal]] = {
+    "engine_rpm": AnalogIn,
+    "speed": AnalogIn,
+    "depth": AnalogIn,
+    "water_temp": AnalogIn,
+    "target_heading": AnalogOut,
+    "bilge_alarm": DigitalIn,
+    "anchor_light": DigitalOut,
+}
 
-@pytest.mark.parametrize(
-    "name",
-    ["engine_rpm", "speed", "depth", "water_temp"],
-)
+
+@pytest.mark.parametrize("name", sorted(_EXAMPLE_EXPECTED))
 def test_each_example_signal_loads(name: str, tmp_path) -> None:  # type: ignore[no-untyped-def]
-    """Every bundled signal JSON parses into a real Signal subclass."""
+    """Every bundled signal JSON parses into the expected Signal subclass."""
     src = resources.files("pgntui.examples.signals").joinpath(f"{name}.json")
     target = tmp_path / f"{name}.json"
     with src.open("rb") as fh:
         target.write_bytes(fh.read())
     sig = load_signal(target)
-    # The 4 bundled signals are all analog_in dashboards. If we ever ship a
-    # digital example, extend this assertion.
-    assert isinstance(sig, AnalogIn)
+    assert isinstance(sig, _EXAMPLE_EXPECTED[name])
     assert sig.id == name
     assert sig.pgn > 0
     assert sig.field
-    assert sig.min < sig.max
-    assert sig.smoothing >= 0
+    if isinstance(sig, AnalogIn | AnalogOut):
+        assert sig.min < sig.max
+    if isinstance(sig, AnalogIn):
+        assert sig.smoothing >= 0
+    if isinstance(sig, AnalogOut | DigitalOut):
+        assert sig.write_pgn > 0
+        assert sig.write_field
 
 
 def test_signal_load_round_trip_all_types(tmp_path) -> None:  # type: ignore[no-untyped-def]

{pgntui-0.2.0 → pgntui-0.2.2}/tests/test_smoke.py

@@ -2,7 +2,7 @@ from pgntui import __version__
 
 
 def test_version() -> None:
-    assert __version__ == "0.2.0"
+    assert __version__ == "0.2.2"
 
 
 def test_main_returns_zero() -> None:

pgntui-0.2.0/src/pgntui/examples/containers/main.json

@@ -1,11 +0,0 @@
-{
-  "id": "main",
-  "title": "Main",
-  "cols": 12,
-  "signals": [
-    {"ref": "engine_rpm", "row": 0, "col": 0, "w": 6},
-    {"ref": "speed",      "row": 0, "col": 6, "w": 6},
-    {"ref": "depth",      "row": 1, "col": 0, "w": 6},
-    {"ref": "water_temp", "row": 1, "col": 6, "w": 6}
-  ]
-}