signalk-cli 3.0.0__tar.gz → 3.0.1__tar.gz

{signalk_cli-3.0.0 → signalk_cli-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: signalk-cli
-Version: 3.0.0
+Version: 3.0.1
 Summary: Query SignalK v2 APIs and export data as CSV, JSON or Apache Arrow Feather from command line or as a Python API
 Keywords: signalk,sailing,marine,boating,nmea,dataframe,cli,pyarrow,nanoarrow
 Author: jey burrows
@@ -30,6 +30,11 @@ Provides-Extra: arrow
 Provides-Extra: feather
 Description-Content-Type: text/markdown
 
+---
+title: SignalK CLI
+description: Command line access to SignalK APIs and streaming data, for piping within console, or export to CSV, JSON or Apache Arrow Feather for dataframe analysis.
+---
+
 # SignalK CLI
 
 [![Rhizomatics Open Source](https://img.shields.io/badge/rhizomatics%20open%20source-lightseagreen)](https://github.com/rhizomatics)
@@ -47,7 +52,31 @@ Description-Content-Type: text/markdown
 
 Query and explore NMEA and other boat data from SignalK APIs using the command line or the Python API.  Export data as CSV, Apache Arrow Feather, or JSON or use as dataframes in scripts or data notebooks.
 
-APIs supported:
+`signalk_cli` goes beyond raw API data extraction to automatically handle metrics and 'wide' tables that bring together aggregates like 'max' or 'avg' into separate columns for simpler queries. It also has an analysis tools to summarize data variability.
+
+<!-- termynal -->
+```
+$ uv run --with signalk-cli signalk_cli.history list-providers
+provider,isDefault
+kip,False
+signalk-parquet,True
+
+uv run --with signalk-cli signalk_cli.history query 'environment.outside.wind.gust:max' 'environment.wind.speedApparent:avg' --duration P7D --resolution 1m
+timestamp,path,value
+2026-10-03T09:11:00Z,environment.wind.speedApparent,5.8
+2026-10-03T09:12:00Z,environment.outside.wind.gust,45.36699999999996
+2026-10-03T09:12:00Z,environment.wind.speedApparent,5.8
+2026-10-03T09:13:00Z,environment.outside.wind.gust,15.317000000000009
+
+uv run --with signalk-cli signalk_cli.stream deltas 'environment.outside.wind.*' --follow
+timestamp,context,source,path,value
+2026-10-03T09:08:21.042Z,vessels.urn:mrn:signalk:uuid:64f1567b-2fc2-474f-8b23-4e9c43b61ffb,simulator.0,environment.outside.wind.gust,44.29449999999997
+2026-10-03T09:08:23.042Z,vessels.urn:mrn:signalk:uuid:64f1567b-2fc2-474f-8b23-4e9c43b61ffb,simulator.0,environment.outside.wind.gust,45.29449999999997
+...
+
+```
+
+## APIs supported:
 
 ### [SignalK v2 History API](https://demo.signalk.org/documentation/Developing/REST_APIs/History_API.html). 
 
@@ -98,7 +127,7 @@ cd signalk-cli
 uv sync
 ```
 
-## Temporary Installation
+## Use without Installing
 
 Use `uv` to run without installing the module permanently, for example:
 
@@ -110,6 +139,12 @@ uv run --with signalk-cli signalk_cli.history list-providers
 uv run --with signalk-cli signalk_cli.stream deltas navigation.position --follow
 ```
 
+Wildcards to follow multiple paths need to be quoted
+
+```bash
+uv run --with signalk-cli signalk_cli.stream deltas 'environment.outside.wind.*' --follow
+```
+
 ## Python library
 
 Everything the CLI does is also available from Python, returning tables that load straight into polars, pandas, pyarrow or DuckDB:
@@ -154,6 +189,7 @@ Commands:
   query           Query history and write results as CSV, Feather, or JSON.
 ```
 
+
 ## Commands
 
 
@@ -473,11 +509,9 @@ python -m signalk_cli.stream deltas [OPTIONS] [PATH...]
 ```
 
 By default, prints the next delta message and exits — useful for a quick check.
-Use `--follow` to keep tailing until interrupted with Ctrl-C, optionally capped
-with `--count`.
+Use `--follow` to keep tailing until interrupted with Ctrl-C, optionally capped with `--count`.
 
-**PATH** arguments are sent verbatim to the server as an explicit subscription,
-one per path. They may be literal SignalK paths (e.g. `navigation.speedOverGround`)
+**PATH** arguments are sent verbatim to the server as an explicit subscription, one per path. They may be literal SignalK paths (e.g. `navigation.speedOverGround`)
 or use the SignalK subscription wildcard `*`, matched server-side per the
 [Subscription Protocol](https://signalk.org/specification/1.8.2/doc/subscription_protocol.html)
 — unlike `history`'s PATH patterns, which the client resolves by matching
@@ -621,3 +655,7 @@ Typical combinations:
 ## Default caching
 
 The default history provider is fetched from the server once and cached per host in `~/.cache/signalk-history-cli/`. Pass `--no-cache` to force a fresh lookup, or `--provider <id>` to target a specific provider explicitly.
+
+## Too Much Streaming Data
+
+If the data is too noisy, like GPS positions with dubious centimeter differences, then [signalk-delta-squelch-plugin](https://github.com/rhizomatics/signalk-delta-squelch-plugin) can cut this down hugely, and also filter out GPS glitches that suggest your boat moves at warp speed.

{signalk_cli-3.0.0 → signalk_cli-3.0.1}/README.md

@@ -1,3 +1,8 @@
+---
+title: SignalK CLI
+description: Command line access to SignalK APIs and streaming data, for piping within console, or export to CSV, JSON or Apache Arrow Feather for dataframe analysis.
+---
+
 # SignalK CLI
 
 [![Rhizomatics Open Source](https://img.shields.io/badge/rhizomatics%20open%20source-lightseagreen)](https://github.com/rhizomatics)
@@ -15,7 +20,31 @@
 
 Query and explore NMEA and other boat data from SignalK APIs using the command line or the Python API.  Export data as CSV, Apache Arrow Feather, or JSON or use as dataframes in scripts or data notebooks.
 
-APIs supported:
+`signalk_cli` goes beyond raw API data extraction to automatically handle metrics and 'wide' tables that bring together aggregates like 'max' or 'avg' into separate columns for simpler queries. It also has an analysis tools to summarize data variability.
+
+<!-- termynal -->
+```
+$ uv run --with signalk-cli signalk_cli.history list-providers
+provider,isDefault
+kip,False
+signalk-parquet,True
+
+uv run --with signalk-cli signalk_cli.history query 'environment.outside.wind.gust:max' 'environment.wind.speedApparent:avg' --duration P7D --resolution 1m
+timestamp,path,value
+2026-10-03T09:11:00Z,environment.wind.speedApparent,5.8
+2026-10-03T09:12:00Z,environment.outside.wind.gust,45.36699999999996
+2026-10-03T09:12:00Z,environment.wind.speedApparent,5.8
+2026-10-03T09:13:00Z,environment.outside.wind.gust,15.317000000000009
+
+uv run --with signalk-cli signalk_cli.stream deltas 'environment.outside.wind.*' --follow
+timestamp,context,source,path,value
+2026-10-03T09:08:21.042Z,vessels.urn:mrn:signalk:uuid:64f1567b-2fc2-474f-8b23-4e9c43b61ffb,simulator.0,environment.outside.wind.gust,44.29449999999997
+2026-10-03T09:08:23.042Z,vessels.urn:mrn:signalk:uuid:64f1567b-2fc2-474f-8b23-4e9c43b61ffb,simulator.0,environment.outside.wind.gust,45.29449999999997
+...
+
+```
+
+## APIs supported:
 
 ### [SignalK v2 History API](https://demo.signalk.org/documentation/Developing/REST_APIs/History_API.html). 
 
@@ -66,7 +95,7 @@ cd signalk-cli
 uv sync
 ```
 
-## Temporary Installation
+## Use without Installing
 
 Use `uv` to run without installing the module permanently, for example:
 
@@ -78,6 +107,12 @@ uv run --with signalk-cli signalk_cli.history list-providers
 uv run --with signalk-cli signalk_cli.stream deltas navigation.position --follow
 ```
 
+Wildcards to follow multiple paths need to be quoted
+
+```bash
+uv run --with signalk-cli signalk_cli.stream deltas 'environment.outside.wind.*' --follow
+```
+
 ## Python library
 
 Everything the CLI does is also available from Python, returning tables that load straight into polars, pandas, pyarrow or DuckDB:
@@ -122,6 +157,7 @@ Commands:
   query           Query history and write results as CSV, Feather, or JSON.
 ```
 
+
 ## Commands
 
 
@@ -441,11 +477,9 @@ python -m signalk_cli.stream deltas [OPTIONS] [PATH...]
 ```
 
 By default, prints the next delta message and exits — useful for a quick check.
-Use `--follow` to keep tailing until interrupted with Ctrl-C, optionally capped
-with `--count`.
+Use `--follow` to keep tailing until interrupted with Ctrl-C, optionally capped with `--count`.
 
-**PATH** arguments are sent verbatim to the server as an explicit subscription,
-one per path. They may be literal SignalK paths (e.g. `navigation.speedOverGround`)
+**PATH** arguments are sent verbatim to the server as an explicit subscription, one per path. They may be literal SignalK paths (e.g. `navigation.speedOverGround`)
 or use the SignalK subscription wildcard `*`, matched server-side per the
 [Subscription Protocol](https://signalk.org/specification/1.8.2/doc/subscription_protocol.html)
 — unlike `history`'s PATH patterns, which the client resolves by matching
@@ -589,3 +623,7 @@ Typical combinations:
 ## Default caching
 
 The default history provider is fetched from the server once and cached per host in `~/.cache/signalk-history-cli/`. Pass `--no-cache` to force a fresh lookup, or `--provider <id>` to target a specific provider explicitly.
+
+## Too Much Streaming Data
+
+If the data is too noisy, like GPS positions with dubious centimeter differences, then [signalk-delta-squelch-plugin](https://github.com/rhizomatics/signalk-delta-squelch-plugin) can cut this down hugely, and also filter out GPS glitches that suggest your boat moves at warp speed.

{signalk_cli-3.0.0 → signalk_cli-3.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "signalk-cli"
-version = "3.0.0"
+version = "3.0.1"
 description = "Query SignalK v2 APIs and export data as CSV, JSON or Apache Arrow Feather from command line or as a Python API"
 readme = "README.md"
 requires-python = ">=3.13"
@@ -62,11 +62,12 @@ dev = [
     "pytest-xdist",
     "mypy",
     "coverage",
+    "bandit",
     "genbadge[all]",
     "icdiff",
     "codespell",
-    "polars>=1.44.2,<2.0.0",
-    "duckdb>=1.5.5,<2.0.0",
+    "polars>=1.44.2,<3.0.0",
+    "duckdb>=1.5.5,<3.0.0",
     "pandas>=3.0.6,<4.0.0",
 ]
 docs = [
@@ -77,8 +78,11 @@ docs = [
     "mkdocs-pagetree-plugin",
     "mkdocs-coverage",
     "pymdown-extensions",
+    "mkdocs-homepage-copier",
     "mkdocs-meta-descriptions-plugin",
     "pngquant",
+    "termynal",
+    "pillow>=13.0.0",
     "mkdocs-htmlproofer-plugin",
     "mkdocs-llmstxt>=0.5.0,<0.6.0",
     "mkdocstrings[python]>=1.0.6,<2.0.0",
@@ -143,6 +147,8 @@ exclude-newer = "7 days"
 add-bounds = "major"
 
 [tool.uv.exclude-newer-package]
+certifi = false
+pillow = false
 uv_build = "2 days"
 
 [tool.uv.build-backend]
@@ -150,5 +156,5 @@ module-root = "src"
 module-name = "signalk_cli"
 
 [build-system]
-requires = ["uv_build>=0.12.0,<0.13.0"]
+requires = ["uv_build>=0.12.0"]
 build-backend = "uv_build"

{signalk_cli-3.0.0 → signalk_cli-3.0.1}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "signalk-cli"
-version = "3.0.0"
+version = "3.0.1"
 description = "Query SignalK v2 APIs and export data as CSV, JSON or Apache Arrow Feather from command line or as a Python API"
 readme = "README.md"
 requires-python = ">=3.13"
@@ -47,11 +47,12 @@ dev = [
     "pytest-xdist",
     "mypy",
     "coverage",
+    "bandit",
     "genbadge[all]",
     "icdiff",
     "codespell",
-    "polars>=1.44.2,<2.0.0",
-    "duckdb>=1.5.5,<2.0.0",
+    "polars>=1.44.2,<3.0.0",
+    "duckdb>=1.5.5,<3.0.0",
     "pandas>=3.0.6,<4.0.0",
 ]
 
@@ -63,8 +64,11 @@ docs=[
     "mkdocs-pagetree-plugin",
     "mkdocs-coverage",
     "pymdown-extensions",
+    "mkdocs-homepage-copier",
     "mkdocs-meta-descriptions-plugin",
     "pngquant",
+    "termynal",
+    "pillow>=13.0.0",
     "mkdocs-htmlproofer-plugin",
     "mkdocs-llmstxt>=0.5.0,<0.6.0",
     "mkdocstrings[python]>=1.0.6,<2.0.0",
@@ -136,11 +140,11 @@ allowed-unresolved-imports = ["pyarrow", "pyarrow.**"]
 compile-bytecode = true
 managed = true
 exclude-newer = "7 days"
-exclude-newer-package = {"uv_build"="2 days"}
+exclude-newer-package = {certifi=false, pillow=false,"uv_build"="2 days"}
 add-bounds = "major"
 
 [build-system]
-requires = ["uv_build>=0.12.0,<0.13.0"]
+requires = ["uv_build>=0.12.0"]
 build-backend = "uv_build"
 
 

{signalk_cli-3.0.0 → signalk_cli-3.0.1}/src/signalk_cli/_arrow.py

@@ -31,7 +31,7 @@ def _epoch_us(ts: str | datetime | None) -> int | None:
     return round(dt.timestamp() * 1_000_000)
 
 
-def infer_column(values: Sequence[Any]) -> tuple[list, Any]:
+def infer_column(values: Sequence[Any]) -> tuple[list[str | float | bool | None], Any]:
     """Pick one Arrow type for a column of JSON values: float64, bool, or string.
 
     Numbers (and nulls) become float64, booleans stay bool, and anything else

{signalk_cli-3.0.0 → signalk_cli-3.0.1}/src/signalk_cli/_cli.py

@@ -3,7 +3,7 @@
 import contextlib
 import io
 import logging
-from collections.abc import Iterator
+from collections.abc import Generator
 
 import click
 
@@ -38,7 +38,7 @@ def bare_option(f):
 
 
 @contextlib.contextmanager
-def stderr_ctx(bare: bool) -> Iterator[None]:
+def stderr_ctx(bare: bool) -> Generator[None]:
     """Route library log messages to stderr for one command, or discard them all if bare."""
     handler = _ClickHandler()
     previous_level = logger.level

{signalk_cli-3.0.0 → signalk_cli-3.0.1}/src/signalk_cli/history/cli.py

@@ -5,7 +5,7 @@ import csv
 import json
 import re
 import sys
-from collections.abc import Iterator
+from collections.abc import Generator
 from datetime import UTC, datetime
 from pathlib import Path
 from urllib.parse import urlparse
@@ -92,7 +92,7 @@ def _client(
 
 
 @contextlib.contextmanager
-def _exit_on_error(doing: str) -> Iterator[None]:
+def _exit_on_error(doing: str) -> Generator[None]:
     """Report a failed request as 'Error <doing>: <message>' and exit 1."""
     try:
         yield