signalk-cli 1.2.0__tar.gz → 2.1.0__tar.gz

{signalk_cli-1.2.0 → signalk_cli-2.1.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: signalk-cli
-Version: 1.2.0
-Summary: Query the SignalK v2 History API and export data as CSV or Apache Arrow Feather
+Version: 2.1.0
+Summary: Query SignalK v2 APIs and export data as CSV, JSON or Apache Arrow Feather
 Keywords: signalk,sailing,marine,nmea,boating
 Author: jey burrows
 Author-email: jey burrows <jrb@rhizomatics.org.uk>
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: click>=8.3.3
-Requires-Dist: niquests>=2.28
+Requires-Dist: niquests[ws]>=2.28
 Requires-Dist: zeroconf>=0.149.16,<0.150.0
 Requires-Dist: pyarrow>=17.0 ; extra == 'feather'
 Requires-Python: >=3.13
@@ -28,14 +28,25 @@ Description-Content-Type: text/markdown
 
 # SignalK CLI
 
-Query and explore SignalK APIs from the command line, and export data as CSV, Apache Arrow Feather, or JSON.
+Query and explore NMEA and other boat data from SignalK APIs using the command line, and export data as CSV, Apache Arrow Feather, or JSON.
 
 APIs supported:
 
-* [SignalK v2 History API](https://signalk.org/https://demo.signalk.org/documentation/Developing/REST_APIs/History_API.html)
+* [SignalK v2 History API](https://signalk.org/https://demo.signalk.org/documentation/Developing/REST_APIs/History_API.html). Commands available:
+  - list-paths
+  - list-providers
+  - list-contexts
+  - query
+  - cardinality
+* [SignalK v1 Streaming API](https://signalk.org/specification/1.8.2/doc/streaming_api.html). Commands available:
+  - deltas
 
 ## Installation
 
+`signalk-cli` is published to PyPi at https://pypi.org/project/signalk-cli/
+
+Python is required to run this, version 3.13 or above. [uv](https://docs.astral.sh/uv/) is the recommended way to install the package ( and can install Python ) but is not required.
+
 ### PyPi
 
 ```pip install signalk-cli``` or ```uv pip install signalk-cli```
@@ -60,14 +71,17 @@ Use `uv` to run without installing the module permanently, for example:
 uv run --with signalk-cli signalk_cli.history list-providers
 ```
 
+```bash
+uv run --with signalk-cli signalk_cli.stream deltas navigation.position --follow
+```
+
 ## Running
 
-Run via `python -m signalk_cli.history <command>`. 
+Run via `python -m signalk_cli.history <command>` or `python -m signalk_cli.stream <command>` or without installing the module with `uv run --with signalk-cli signalk_cli.history <command>`.
 
 ## Determining SignalK host name
 
-If no host name is set as an argument, the CLI will look for a `SIGNALK_HOST` environment variable, and failing that attempt to automatically discover
-the host using mDNS (aka Bonjour) and locally cached (see [Default Caching](#default-caching)).
+If no host name is set as an argument, the CLI will look for a `SIGNALK_HOST` environment variable, and failing that attempt to automatically discover the host using mDNS (aka Bonjour) and locally cached (see [Default Caching](#default-caching)).
 
 ```bash
 export SIGNALK_HOST=192.168.6.99   # http:// is added automatically if omitted
@@ -395,6 +409,137 @@ python -m signalk_cli.history list-contexts --host 10.36.10.21 --format raw --ba
 
 ---
 
+## SignalK v1 Streaming API
+
+The `signalk_cli.stream` module connects to a running SignalK server's live delta
+WebSocket feed (as opposed to `signalk_cli.history`, which queries recorded history).
+
+### `deltas`
+
+Stream live delta updates from the SignalK v1 Streaming API.
+
+```
+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`.
+
+**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
+against the server's enumerated `/paths` list:
+
+- `*` at the end of a path matches any suffix, e.g. `navigation.*`
+- `*` as a middle segment matches any single segment there, e.g. `propulsion.*.oilTemperature`
+- a bare `*` subscribes to every path in the context
+
+Quote wildcarded paths (e.g. `'navigation.*'`) so the shell doesn't expand them
+against local filenames first.
+
+`deltas` always sends its own explicit subscribe message for `--context`
+(default `vessels.self`), covering PATH arguments if given, otherwise every
+path (`*`). `--context` also accepts the SignalK wildcard: `'*'` or
+`'vessels.*'` subscribes to every vessel, not just your own. `--policy`,
+`--period`, and `--min-period` control that subscription per the
+[Subscription Protocol](https://signalk.org/specification/1.8.2/doc/subscription_protocol.html)'s
+`policy`/`period`/`minPeriod` fields:
+
+- **`--policy`** (`instant` / `ideal` / `fixed`, default `ideal`): `instant` sends every change (throttled by `--min-period`); `ideal` behaves like `instant` but resends the last value if nothing changes within `--period`; `fixed` always sends the last known value every `--period`, regardless of changes.
+- **`--period`** (seconds, default `60`): the resend interval for `ideal`/`fixed`. Converted to milliseconds on the wire.
+- **`--min-period`** (seconds): fastest allowed transmission rate, only meaningful with `--policy instant`.
+
+The protocol also defines a per-path `format` field (`delta`/`full`), but
+this CLI doesn't expose it: signalk-server rejects `full` outright ("Only
+delta format supported, using it") and always sends delta messages
+regardless, so the choice would be misleading.
+
+**`--subscribe` is a separate, easily-confused mechanism**: it's the
+connection-level `subscribe` query parameter (`none`/`self`/`all`), which
+controls whether the server *additionally* auto-subscribes the connection
+at **its own** default policy/period — you don't get to choose the rate.
+This CLI defaults it to `none`, diverging from the SignalK spec's own
+default of `self`, because `deltas` always sends its own explicit `--context`
+subscription anyway; leaving the connection-level default at `self` would
+just double up on updates for your own vessel.
+
+So there are two different ways to see every vessel, and they're not
+interchangeable:
+
+| Want | Use | Policy/period used |
+|---|---|---|
+| Just your own vessel | (defaults) | Yours (`--policy`/`--period`) |
+| Every vessel, at your chosen rate | `--context '*'` | Yours (`--policy`/`--period`) |
+| Every vessel, at whatever rate the server defaults to | `--subscribe all` | The server's own default |
+
+#### Options
+
+| Option | Default | Description |
+|---|---|---|
+| `--host` | `$SIGNALK_HOST` | Server base URL. `http://` added if scheme omitted; converted to `ws://`/`wss://` for the stream connection. |
+| `--no-cache` | — | Ignore the cached host |
+| `-c, --context TEXT` | `vessels.self` | SignalK context |
+| `--subscribe [none\|self\|all]` | `none` | Connection-level subscribe policy (SignalK's own `subscribe` query parameter); see above |
+| `--policy [instant\|ideal\|fixed]` | `ideal` | Per-path subscribe `policy` field; see above |
+| `--period SECONDS` | `60` | Per-path subscribe `period` field, in seconds (converted to ms) |
+| `--min-period SECONDS` | — | Per-path subscribe `minPeriod` field, in seconds (converted to ms); only meaningful with `--policy instant` |
+| `--format [csv\|json\|raw\|feather]` | from extension, else csv | Output format. `json` is JSON Lines (one row object per line, suitable for a live stream). `raw` is the exact delta message text, one per line. `feather` requires `pip install 'signalk-cli[feather]'` and `--output` (cannot stream to stdout). |
+| `--no-header` | — | Suppress the CSV header row |
+| `--include-meta` | — | Also emit rows for `meta` entries (units, description, zones, etc.), not just `values`. Adds a `kind` column (`value`/`meta`) to csv/json/feather output. Ignored for `--format raw`, which always includes meta as-is. |
+| `-o, --output [FILE]` | stdout | Write to a file. Omit the filename (`--output` alone) to auto-name as `signalk-stream-<server>-<timestamp>.<ext>`. Required for `--format feather`. |
+| `-f, --follow` | — | Keep streaming until interrupted (Ctrl-C) or `--count` is reached. Without this, print the next message then exit. |
+| `-n, --count N` | 1 without `--follow`, unlimited with it | Number of delta messages to output |
+| `--bare` | — | Print to stdout with **no informational messages**. Ideal for piping to other tools. |
+
+#### Output formats
+
+**csv** / **json**: `timestamp, context, source, path, value` — one row per `path`/`value` pair in each delta's updates, written incrementally as messages arrive. Structured values (e.g. `navigation.position`) are JSON-encoded in the `value` column. With `--include-meta`, a `kind` column (`value`/`meta`) is inserted before `value`, and `meta` entries (units, description, zones, etc. — also JSON-encoded) are included as rows too; without it, `meta` entries are silently dropped from csv/json/feather (they're still present in `raw`).
+
+**raw**: the exact delta message JSON as received from the server, one message per line.
+
+**feather**: Apache Arrow Feather binary format, same columns as csv/json. Requires `pip install 'signalk-cli[feather]'`. Unlike the other formats, rows are buffered in memory across all received messages and written once the session ends (`--count` reached, or Ctrl-C with `--follow`) — cannot be streamed to stdout.
+
+#### Examples
+
+```bash
+# Next update for one path, then exit
+python -m signalk_cli.stream deltas --host 10.36.10.21 navigation.speedOverGround
+
+# Tail all navigation updates until Ctrl-C
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow 'navigation.*'
+
+# Tail oil temperature across every engine (mid-path wildcard)
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow 'propulsion.*.oilTemperature'
+
+# Next 20 messages across all subscribed paths, as JSON Lines
+python -m signalk_cli.stream deltas --host 10.36.10.21 --format json --count 20
+
+# Tail two specific paths, piping raw deltas to another tool
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow --format raw --bare \
+    navigation.speedOverGround navigation.courseOverGroundTrue
+
+# Everything the server has (equivalent to ?subscribe=all), following
+python -m signalk_cli.stream deltas --host 10.36.10.21 --subscribe all --follow
+
+# Faster resend interval (5s instead of the 60s default)
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow --period 5 'navigation.*'
+
+# Send every change immediately, no more than 5 times/second
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow \
+    --policy instant --min-period 0.2 navigation.speedOverGround
+
+# Capture 500 messages to an auto-named Feather file
+python -m signalk_cli.stream deltas --host 10.36.10.21 --count 500 --format feather --output 'navigation.*'
+
+# Capture until Ctrl-C to a named Feather file
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow -o capture.feather 'navigation.*'
+```
+
+---
+
 ## Time range
 
 All commands that query data accept the same three time parameters. At least one of `--from` or `--duration` must be provided (or the tool supplies a one-hour default).

{signalk_cli-1.2.0 → signalk_cli-2.1.0}/README.md

@@ -1,13 +1,24 @@
 # SignalK CLI
 
-Query and explore SignalK APIs from the command line, and export data as CSV, Apache Arrow Feather, or JSON.
+Query and explore NMEA and other boat data from SignalK APIs using the command line, and export data as CSV, Apache Arrow Feather, or JSON.
 
 APIs supported:
 
-* [SignalK v2 History API](https://signalk.org/https://demo.signalk.org/documentation/Developing/REST_APIs/History_API.html)
+* [SignalK v2 History API](https://signalk.org/https://demo.signalk.org/documentation/Developing/REST_APIs/History_API.html). Commands available:
+  - list-paths
+  - list-providers
+  - list-contexts
+  - query
+  - cardinality
+* [SignalK v1 Streaming API](https://signalk.org/specification/1.8.2/doc/streaming_api.html). Commands available:
+  - deltas
 
 ## Installation
 
+`signalk-cli` is published to PyPi at https://pypi.org/project/signalk-cli/
+
+Python is required to run this, version 3.13 or above. [uv](https://docs.astral.sh/uv/) is the recommended way to install the package ( and can install Python ) but is not required.
+
 ### PyPi
 
 ```pip install signalk-cli``` or ```uv pip install signalk-cli```
@@ -32,14 +43,17 @@ Use `uv` to run without installing the module permanently, for example:
 uv run --with signalk-cli signalk_cli.history list-providers
 ```
 
+```bash
+uv run --with signalk-cli signalk_cli.stream deltas navigation.position --follow
+```
+
 ## Running
 
-Run via `python -m signalk_cli.history <command>`. 
+Run via `python -m signalk_cli.history <command>` or `python -m signalk_cli.stream <command>` or without installing the module with `uv run --with signalk-cli signalk_cli.history <command>`.
 
 ## Determining SignalK host name
 
-If no host name is set as an argument, the CLI will look for a `SIGNALK_HOST` environment variable, and failing that attempt to automatically discover
-the host using mDNS (aka Bonjour) and locally cached (see [Default Caching](#default-caching)).
+If no host name is set as an argument, the CLI will look for a `SIGNALK_HOST` environment variable, and failing that attempt to automatically discover the host using mDNS (aka Bonjour) and locally cached (see [Default Caching](#default-caching)).
 
 ```bash
 export SIGNALK_HOST=192.168.6.99   # http:// is added automatically if omitted
@@ -367,6 +381,137 @@ python -m signalk_cli.history list-contexts --host 10.36.10.21 --format raw --ba
 
 ---
 
+## SignalK v1 Streaming API
+
+The `signalk_cli.stream` module connects to a running SignalK server's live delta
+WebSocket feed (as opposed to `signalk_cli.history`, which queries recorded history).
+
+### `deltas`
+
+Stream live delta updates from the SignalK v1 Streaming API.
+
+```
+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`.
+
+**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
+against the server's enumerated `/paths` list:
+
+- `*` at the end of a path matches any suffix, e.g. `navigation.*`
+- `*` as a middle segment matches any single segment there, e.g. `propulsion.*.oilTemperature`
+- a bare `*` subscribes to every path in the context
+
+Quote wildcarded paths (e.g. `'navigation.*'`) so the shell doesn't expand them
+against local filenames first.
+
+`deltas` always sends its own explicit subscribe message for `--context`
+(default `vessels.self`), covering PATH arguments if given, otherwise every
+path (`*`). `--context` also accepts the SignalK wildcard: `'*'` or
+`'vessels.*'` subscribes to every vessel, not just your own. `--policy`,
+`--period`, and `--min-period` control that subscription per the
+[Subscription Protocol](https://signalk.org/specification/1.8.2/doc/subscription_protocol.html)'s
+`policy`/`period`/`minPeriod` fields:
+
+- **`--policy`** (`instant` / `ideal` / `fixed`, default `ideal`): `instant` sends every change (throttled by `--min-period`); `ideal` behaves like `instant` but resends the last value if nothing changes within `--period`; `fixed` always sends the last known value every `--period`, regardless of changes.
+- **`--period`** (seconds, default `60`): the resend interval for `ideal`/`fixed`. Converted to milliseconds on the wire.
+- **`--min-period`** (seconds): fastest allowed transmission rate, only meaningful with `--policy instant`.
+
+The protocol also defines a per-path `format` field (`delta`/`full`), but
+this CLI doesn't expose it: signalk-server rejects `full` outright ("Only
+delta format supported, using it") and always sends delta messages
+regardless, so the choice would be misleading.
+
+**`--subscribe` is a separate, easily-confused mechanism**: it's the
+connection-level `subscribe` query parameter (`none`/`self`/`all`), which
+controls whether the server *additionally* auto-subscribes the connection
+at **its own** default policy/period — you don't get to choose the rate.
+This CLI defaults it to `none`, diverging from the SignalK spec's own
+default of `self`, because `deltas` always sends its own explicit `--context`
+subscription anyway; leaving the connection-level default at `self` would
+just double up on updates for your own vessel.
+
+So there are two different ways to see every vessel, and they're not
+interchangeable:
+
+| Want | Use | Policy/period used |
+|---|---|---|
+| Just your own vessel | (defaults) | Yours (`--policy`/`--period`) |
+| Every vessel, at your chosen rate | `--context '*'` | Yours (`--policy`/`--period`) |
+| Every vessel, at whatever rate the server defaults to | `--subscribe all` | The server's own default |
+
+#### Options
+
+| Option | Default | Description |
+|---|---|---|
+| `--host` | `$SIGNALK_HOST` | Server base URL. `http://` added if scheme omitted; converted to `ws://`/`wss://` for the stream connection. |
+| `--no-cache` | — | Ignore the cached host |
+| `-c, --context TEXT` | `vessels.self` | SignalK context |
+| `--subscribe [none\|self\|all]` | `none` | Connection-level subscribe policy (SignalK's own `subscribe` query parameter); see above |
+| `--policy [instant\|ideal\|fixed]` | `ideal` | Per-path subscribe `policy` field; see above |
+| `--period SECONDS` | `60` | Per-path subscribe `period` field, in seconds (converted to ms) |
+| `--min-period SECONDS` | — | Per-path subscribe `minPeriod` field, in seconds (converted to ms); only meaningful with `--policy instant` |
+| `--format [csv\|json\|raw\|feather]` | from extension, else csv | Output format. `json` is JSON Lines (one row object per line, suitable for a live stream). `raw` is the exact delta message text, one per line. `feather` requires `pip install 'signalk-cli[feather]'` and `--output` (cannot stream to stdout). |
+| `--no-header` | — | Suppress the CSV header row |
+| `--include-meta` | — | Also emit rows for `meta` entries (units, description, zones, etc.), not just `values`. Adds a `kind` column (`value`/`meta`) to csv/json/feather output. Ignored for `--format raw`, which always includes meta as-is. |
+| `-o, --output [FILE]` | stdout | Write to a file. Omit the filename (`--output` alone) to auto-name as `signalk-stream-<server>-<timestamp>.<ext>`. Required for `--format feather`. |
+| `-f, --follow` | — | Keep streaming until interrupted (Ctrl-C) or `--count` is reached. Without this, print the next message then exit. |
+| `-n, --count N` | 1 without `--follow`, unlimited with it | Number of delta messages to output |
+| `--bare` | — | Print to stdout with **no informational messages**. Ideal for piping to other tools. |
+
+#### Output formats
+
+**csv** / **json**: `timestamp, context, source, path, value` — one row per `path`/`value` pair in each delta's updates, written incrementally as messages arrive. Structured values (e.g. `navigation.position`) are JSON-encoded in the `value` column. With `--include-meta`, a `kind` column (`value`/`meta`) is inserted before `value`, and `meta` entries (units, description, zones, etc. — also JSON-encoded) are included as rows too; without it, `meta` entries are silently dropped from csv/json/feather (they're still present in `raw`).
+
+**raw**: the exact delta message JSON as received from the server, one message per line.
+
+**feather**: Apache Arrow Feather binary format, same columns as csv/json. Requires `pip install 'signalk-cli[feather]'`. Unlike the other formats, rows are buffered in memory across all received messages and written once the session ends (`--count` reached, or Ctrl-C with `--follow`) — cannot be streamed to stdout.
+
+#### Examples
+
+```bash
+# Next update for one path, then exit
+python -m signalk_cli.stream deltas --host 10.36.10.21 navigation.speedOverGround
+
+# Tail all navigation updates until Ctrl-C
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow 'navigation.*'
+
+# Tail oil temperature across every engine (mid-path wildcard)
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow 'propulsion.*.oilTemperature'
+
+# Next 20 messages across all subscribed paths, as JSON Lines
+python -m signalk_cli.stream deltas --host 10.36.10.21 --format json --count 20
+
+# Tail two specific paths, piping raw deltas to another tool
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow --format raw --bare \
+    navigation.speedOverGround navigation.courseOverGroundTrue
+
+# Everything the server has (equivalent to ?subscribe=all), following
+python -m signalk_cli.stream deltas --host 10.36.10.21 --subscribe all --follow
+
+# Faster resend interval (5s instead of the 60s default)
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow --period 5 'navigation.*'
+
+# Send every change immediately, no more than 5 times/second
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow \
+    --policy instant --min-period 0.2 navigation.speedOverGround
+
+# Capture 500 messages to an auto-named Feather file
+python -m signalk_cli.stream deltas --host 10.36.10.21 --count 500 --format feather --output 'navigation.*'
+
+# Capture until Ctrl-C to a named Feather file
+python -m signalk_cli.stream deltas --host 10.36.10.21 --follow -o capture.feather 'navigation.*'
+```
+
+---
+
 ## Time range
 
 All commands that query data accept the same three time parameters. At least one of `--from` or `--duration` must be provided (or the tool supplies a one-hour default).

signalk_cli-2.1.0/pyproject.toml

@@ -0,0 +1,117 @@
+[project]
+name = "signalk-cli"
+version = "2.1.0"
+description = "Query SignalK v2 APIs and export data as CSV, JSON or Apache Arrow Feather"
+readme = "README.md"
+requires-python = ">=3.13"
+license = "Apache-2.0"
+keywords = [
+    "signalk",
+    "sailing",
+    "marine",
+    "nmea",
+    "boating",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Natural Language :: English",
+    "Intended Audience :: Developers",
+    "Topic :: Scientific/Engineering",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "click>=8.3.3",
+    "niquests[ws]>=2.28",
+    "zeroconf>=0.149.16,<0.150.0",
+]
+
+[[project.authors]]
+name = "jey burrows"
+email = "jrb@rhizomatics.org.uk"
+
+[project.optional-dependencies]
+feather = ["pyarrow>=17.0"]
+
+[project.urls]
+Homepage = "https://github.com/rhizomatics/signalk-cli"
+Repository = "https://github.com/rhizomatics/signalk-cli"
+Issues = "https://github.com/rhizomatics/signalk-cli/issues"
+Changelog = "https://github.com/rhizomatics/signalk-cli/blob/main/CHANGELOG.md"
+
+[project.scripts]
+"signalk_cli.history" = "signalk_cli.history.cli:cli"
+"signalk_cli.stream" = "signalk_cli.stream.cli:cli"
+
+[dependency-groups]
+dev = [
+    "ruff>=0.16.0",
+    "pre-commit>=4.4.0",
+    "pytest>=9.0.0",
+    "pytest-mock>=3.15.0",
+    "pytest-cov>=7.0.0",
+    "pytest-xdist",
+    "mypy",
+    "coverage",
+    "icdiff",
+    "codespell",
+]
+
+[tool.bandit]
+exclude_dirs = ["tests"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.pytest.ini_options]
+pythonpath = [
+    "src",
+    ".",
+]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+norecursedirs = [".git"]
+
+[tool.coverage.run]
+branch = true
+source = ["src"]
+
+[tool.coverage.report]
+fail_under = 0
+
+[tool.coverage.xml]
+output = "cov.xml"
+
+[tool.coverage.html]
+directory = "htmlcov"
+
+[tool.codespell]
+skip = ".venv,.git,htmlcov,site,./.*,*.csv,*.json,README.*.md,support"
+count = true
+quiet-level = 2
+ignore-words-list = "hass,referer,uint"
+
+[tool.mypy]
+mypy_path = ["./src"]
+
+[tool.uv]
+compile-bytecode = true
+managed = true
+exclude-newer = "7 days"
+add-bounds = "major"
+
+[tool.uv.exclude-newer-package]
+uv_build = "2 days"
+
+[tool.uv.build-backend]
+module-root = "src"
+module-name = "signalk_cli"
+
+[build-system]
+requires = ["uv_build>=0.12.0,<0.13.0"]
+build-backend = "uv_build"

signalk_cli-1.2.0/pyproject.toml → signalk_cli-2.1.0/pyproject.toml.orig

@@ -1,7 +1,7 @@
 [project]
 name = "signalk-cli"
-version = "1.2.0"
-description = "Query the SignalK v2 History API and export data as CSV or Apache Arrow Feather"
+version = "2.1.0"
+description = "Query SignalK v2 APIs and export data as CSV, JSON or Apache Arrow Feather"
 readme = "README.md"
 requires-python = ">=3.13"
 license="Apache-2.0"
@@ -23,7 +23,7 @@ classifiers = [
 
 dependencies = [
     "click>=8.3.3",
-    "niquests>=2.28",
+    "niquests[ws]>=2.28",
     "zeroconf>=0.149.16,<0.150.0",
 ]
 
@@ -31,7 +31,7 @@ dependencies = [
 feather = ["pyarrow>=17.0"]
 [dependency-groups]
 dev = [
-    "ruff>=0.15.0",
+    "ruff>=0.16.0",
     "pre-commit>=4.4.0",
     "pytest>=9.0.0",
     "pytest-mock>=3.15.0",
@@ -101,11 +101,12 @@ mypy_path=["./src"]
 [tool.uv]
 compile-bytecode = true
 managed = true
-exclude-newer = "5 days"
+exclude-newer = "7 days"
+exclude-newer-package = {"uv_build"="2 days"}
 add-bounds = "major"
 
 [build-system]
-requires = ["uv_build>=0.11.13,<0.12.0"]
+requires = ["uv_build>=0.12.0,<0.13.0"]
 build-backend = "uv_build"
 
 
@@ -115,3 +116,4 @@ module-name = "signalk_cli"
 
 [project.scripts]
 "signalk_cli.history" = "signalk_cli.history.cli:cli"
+"signalk_cli.stream" = "signalk_cli.stream.cli:cli"

{signalk_cli-1.2.0 → signalk_cli-2.1.0}/src/signalk_cli/__main__.py

@@ -2,6 +2,8 @@
 
 print("Supported SignalK APIs:")
 print("  signalk_cli.history  — SignalK v2 History API")
+print("  signalk_cli.stream   — SignalK v1 Streaming (delta) API")
 print()
 print("Usage: python -m signalk_cli.<api> [COMMAND] [OPTIONS]")
 print("       python -m signalk_cli.history --help")
+print("       python -m signalk_cli.stream --help")

{signalk_cli-1.2.0 → signalk_cli-2.1.0}/src/signalk_cli/history/cli.py

@@ -1,35 +1,30 @@
 """Click CLI for the SignalK v2 History API."""
 
-import contextlib
 import csv
-import io
 import json
 import re
 import sys
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from pathlib import Path
 from urllib.parse import urlparse
 
 import click
 import niquests
 
+from ..net import bare_option, host_option, resolve_host, stderr_ctx
 from .history_api import (
     HISTORY_BASE,
     api_error,
     apply_time_default,
-    discover_host,
     expand_paths,
     fetch_server_paths,
-    get_cached_host,
     normalise_duration,
-    normalise_host,
     resolve_provider,
-    save_cached_host,
 )
 from .output import (
+    _POSITION_RE,
     CARDINALITY_COLUMNS,
     FEATHER_EXTENSIONS,
-    _POSITION_RE,
     compute_cardinality,
     write_csv,
     write_csv_wide,
@@ -72,35 +67,8 @@ def _list_fmt_callback(ctx, param, value):
     raise click.BadParameter(f"'{value}' is not one of 'csv', 'json', 'raw'")
 
 
-def _host_option(f):
-    return click.option(
-        "--host",
-        default=None,
-        envvar="SIGNALK_HOST",
-        help="SignalK server base URL. http:// added if scheme omitted. "
-        "Discovered via mDNS if omitted.",
-    )(f)
-
-
-def _resolve_host(host: str | None, no_cache: bool = False) -> str:
-    """Return a normalised host URL, discovering via mDNS if none provided."""
-    if host:
-        return normalise_host(host)
-    if not no_cache:
-        cached = get_cached_host()
-        if cached:
-            click.echo(f"Using cached host: {cached}", err=True)
-            return cached
-    click.echo("No host specified — searching for SignalK via mDNS...", err=True)
-    discovered = discover_host()
-    if not discovered:
-        raise click.UsageError(
-            "No SignalK server found via mDNS. Use --host or set SIGNALK_HOST."
-        )
-    click.echo(f"Discovered: {discovered}", err=True)
-    if not no_cache:
-        save_cached_host(discovered)
-    return discovered
+_host_option = host_option
+_resolve_host = resolve_host
 
 
 def _provider_options(f):
@@ -127,18 +95,8 @@ def _time_options(f):
     return f
 
 
-def _bare_option(f):
-    return click.option(
-        "--bare",
-        is_flag=True,
-        help="Suppress all informational messages, outputting data only.",
-    )(f)
-
-
-def _stderr_ctx(bare: bool) -> contextlib.AbstractContextManager:
-    return (
-        contextlib.redirect_stderr(io.StringIO()) if bare else contextlib.nullcontext()
-    )
+_bare_option = bare_option
+_stderr_ctx = stderr_ctx
 
 
 def _build_time_params(from_: str | None, to: str | None, duration: str | None) -> dict:
@@ -341,7 +299,7 @@ def query(
         # Generate auto-named file path now that format is known
         if auto_name:
             server_name = urlparse(host).hostname or re.sub(r"[^\w.-]", "_", host)
-            ts = datetime.now(timezone.utc).strftime("%Y%m%dT%H%M%SZ")
+            ts = datetime.now(UTC).strftime("%Y%m%dT%H%M%SZ")
             ext = (
                 ".feather"
                 if fmt == "feather"