lr-lumenlabel-cli 3.0.0__py3-none-any.whl

lr_lumenlabel_cli-3.0.0.dist-info/METADATA

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: lr-lumenlabel-cli
+Version: 3.0.0
+Summary: CLI for the LumenRadio LumenLabel label printing station: import label packages fetched from Arena with gladiator, list labels and inspect the station, locally, on the LAN or through the Fleet relay.
+Author-email: Jonas Estberger <jonas.estberger@lumenradio.com>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/lumenradio/production/lumenlabel
+Project-URL: Changelog, https://gitlab.com/lumenradio/production/lumenlabel/-/blob/main/CHANGELOG.md
+Keywords: LumenRadio,LumenLabel,label printing,Arena,CLI
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.12
+Requires-Dist: rich>=13.7
+Requires-Dist: httpx>=0.27
+Requires-Dist: lr-fleet>=0.7
+Provides-Extra: dev
+Requires-Dist: build>=1.2.1; extra == "dev"
+Requires-Dist: twine>=6.1; extra == "dev"
+Requires-Dist: pytest>=8.4; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: black>=25.9; extra == "dev"
+Requires-Dist: setuptools_scm>=8; extra == "dev"
+Provides-Extra: package
+Requires-Dist: pyinstaller==6.21.0; extra == "package"
+Dynamic: license-file
+
+# lr-lumenlabel-cli
+
+The `lumenlabel` command for LumenRadio LumenLabel label printing stations.
+It turns a label fetched from Arena with gladiator into a label package and
+imports it into a station, locally, on the LAN or through the Fleet relay.
+
+## Installation
+
+```bash
+pip install lr-lumenlabel-cli
+```
+
+The LumenLabel installers also put it on every station: the `.msi` as
+`lumenlabel.exe` on the system `PATH`, the `.deb` as `/usr/bin/lumenlabel`.
+There it imports from a USB stick without a network (airgapped mode).
+
+## Quick start
+
+```bash
+# Fetch the label with its Arena metadata and BOM children
+gladiator get-files 109-1182 --recursive --meta-data --out 109-1182
+
+# Write the manifest and show Build Words and media warnings, offline
+lumenlabel label import 109-1182 --dry-run
+
+# Import into the LumenLabel running on this computer
+lumenlabel label import 109-1182
+
+# Or remember a station once, then import into it
+lumenlabel login --station https://fleet.cloud.lumenradio.com/v1/s/<uid>
+lumenlabel label import 109-1182
+lumenlabel label list
+```
+
+## Commands
+
+```
+lumenlabel [--station URL] [--token TOKEN] COMMAND   # global options first
+
+lumenlabel login --station URL [--token TOKEN]
+  # Checks the station and remembers it, with its token, in
+  # ~/.config/lumenlabel/login.json (0600). Every later command then talks
+  # to that station as if it were the local one. --base-url is an alias of
+  # --station, as in lumentest.
+lumenlabel logout
+
+lumenlabel label import DIR [--dry-run] [--invalidate] [--output rich|json]
+lumenlabel label list   [--output rich|json]
+lumenlabel label remove ARTICLE [--yes]
+
+lumenlabel station      [--output rich|json]       # info
+lumenlabel station history [--limit N] [--before ID]
+lumenlabel station logs [--tail N]
+
+lumenlabel api METHOD PATH [--data JSON|@FILE]     # any /api/ endpoint
+lumenlabel --version
+```
+
+## Which station
+
+1. `--station URL` (alias `--base-url`), or `LUMENLABEL_STATION` /
+   `LUMENLABEL_URL`.
+2. The station saved by `lumenlabel login`.
+3. The LumenLabel on this computer, `http://127.0.0.1:<port>`. The port is
+   read from the station's `lumenlabel.json` (default 17081).
+
+| URL | Authentication |
+|---|---|
+| `https://<fleet>/v1/s/<uid>` (Fleet relay) | Your Fleet sign-in (`fleet login`; the first command opens the browser if needed) |
+| `http://127.0.0.1:<port>` (on the station) | None |
+| `http://<station>:<port>` (LAN, `instrumentation.host` `0.0.0.0` on the station) | The station token, shown in admin mode on the station |
+
+## `label import`
+
+- The manifest (`artifact-manifest.json`) is built from the `.arena.json`
+  sidecars gladiator writes with `--meta-data`. A folder with a manifest and no
+  sidecars is imported as it is.
+- Private attachments (NiceLabel `.nlbl` sources), web links and BOM child
+  folders are left out. Only the declared files are uploaded.
+- The media in `configuration.json` (`media_article`, `media_name`) is checked
+  against the BOM's 111 item. A mismatch is a warning; fix it with a new
+  revision in Arena. The CLI never changes `configuration.json`.
+- A read-only folder (a write-protected USB stick) is imported through a
+  temporary copy.
+- An interrupted import resumes: run it again and only the files that did not
+  arrive are sent. `--invalidate` discards what the station has staged.
+- The output shows the revision, the Build Words, the media and any warnings.
+
+Specification: `doc/label-package.md` and `doc/api-reference.md` in the
+[LumenLabel repository](https://gitlab.com/lumenradio/production/lumenlabel).

lr_lumenlabel_cli-3.0.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+lr_lumenlabel_cli-3.0.0.dist-info/licenses/LICENSE,sha256=cEnG3HeMPa3GKtuENkytOQaNJS9rwMMU_KWHObdWbOY,1070
+lumenlabel/__init__.py,sha256=fj1drjftWKEMssQcz1DSbwsgdSPDNARj-L2vVZ9WFxc,233
+lumenlabel/__main__.py,sha256=J0EGKk19CsNu3cRu60xavdV_0XGE3eIcSG5ELFJnj4U,60
+lumenlabel/_version.py,sha256=Q5KDuzxagP6DhS0ZWCmUUKtPbVMNBgYpVtHVHkQdyPQ,520
+lumenlabel/build_words.py,sha256=GcBtfcxUpFNWKeHBFt-is_KfItmzOaxFMgVw3Hewdds,2639
+lumenlabel/cli.py,sha256=3xw7OmX13MdbRXb2zklgckmDuQrJA_9HKCnweBC0bao,1547
+lumenlabel/client.py,sha256=Urf3csuoACv88p1bkh8AlXRTSh06YRxwWNZMAXerIoo,12654
+lumenlabel/config.py,sha256=aViVRNq4z3mOrTXt2qzjUd3QSSe3g1fOpSAt9tC3DCc,4344
+lumenlabel/config_rules.py,sha256=vbeQyAMAQrQq8jJsSFldheayUKOGWopw_wmAuHyFDkA,3593
+lumenlabel/importer.py,sha256=SL5DaED9BcCTtkgdor5u7S76lYFVmIFejcplkqmBG3U,1755
+lumenlabel/manifest_gen.py,sha256=vo6dO_Rx_m_DvgAF9rMBMFrADNhok8tmpIYByq2Xvgs,8683
+lumenlabel/media_check.py,sha256=AACA8pbOmuu1jCwJcyUNGOeIb93g7_7tu7Bx4DLpGRE,2534
+lumenlabel/package.py,sha256=65KIamKMW-hecW-QU0u2Lwo2TPfpuOyw676JPObuQng,10330
+lumenlabel/shared.py,sha256=5OGLGoH1MN_ZsiQqaA37LUpzOBP64DdSmoenxOVTS4w,4056
+lumenlabel/commands/__init__.py,sha256=yH4or3_GDcDktoZVW8xswsjNEgmy4JJu3oKhvIfM7Jw,44
+lumenlabel/commands/api.py,sha256=7vWAWLUxDu57xZnm5iLPX73oSNRqDZPC6d9DBManb2Q,1934
+lumenlabel/commands/auth.py,sha256=ryg1gxLHw1Bwnv3bqFSWf7iJvF71eoLRXb3qyOYBP-4,1763
+lumenlabel/commands/label.py,sha256=jIiVCCHice5DaxjFa1bpsimQ7qcAklyB-Nl9bi7CTS8,8404
+lumenlabel/commands/station.py,sha256=g-0mzHs6zZAJcfK-b5MAnf-Wa_fahZANR2Ocn_eyJeQ,3829
+lumenlabel/wordlist/bip39-english.txt,sha256=L17tU6Rye0v4iA2PPxme_JDlhQNkbZ_47_Oi7Tsk29o,13116
+lr_lumenlabel_cli-3.0.0.dist-info/METADATA,sha256=hrsjqls1XkeKXb-FmDvMCQihaczt3SQL82JrTQzDcQg,4908
+lr_lumenlabel_cli-3.0.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+lr_lumenlabel_cli-3.0.0.dist-info/entry_points.txt,sha256=CUcNRGGZTs_AOOIfeQT4s9I_sG9cGm-QGu8acga9roo,50
+lr_lumenlabel_cli-3.0.0.dist-info/top_level.txt,sha256=xW-gRTlQyGA7rjRy7FaqXLuItrMeY9LL9k6koSbxAZQ,11
+lr_lumenlabel_cli-3.0.0.dist-info/RECORD,,

lr_lumenlabel_cli-3.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

lr_lumenlabel_cli-3.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+lumenlabel = lumenlabel.cli:app

lr_lumenlabel_cli-3.0.0.dist-info/licenses/LICENSE

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

lr_lumenlabel_cli-3.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+lumenlabel

lumenlabel/__init__.py

@@ -0,0 +1,6 @@
+"""lr-lumenlabel-cli: the ``lumenlabel`` command for LumenLabel stations."""
+
+try:
+    from lumenlabel._version import __version__
+except ImportError:  # pragma: no cover - written by setuptools_scm
+    __version__ = "0.0.0+unknown"

lumenlabel/__main__.py

@@ -0,0 +1,3 @@
+from lumenlabel.cli import app
+
+app(prog_name="lumenlabel")

lumenlabel/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '3.0.0'
+__version_tuple__ = version_tuple = (3, 0, 0)
+
+__commit_id__ = commit_id = None

lumenlabel/build_words.py

@@ -0,0 +1,75 @@
+"""Build Words: a two-word BIP39 fingerprint of a label package's files[].
+
+A copy of the station's ``src/build_words.py`` and ``src/wordlist/``, so the
+CLI and the station always give the same words for the same files.
+``cli/tests/test_build_words.py`` fails when the copies drift.
+Algorithm: doc/label-package.md §6.
+"""
+
+from __future__ import annotations
+
+import hashlib
+import json
+from pathlib import Path
+from typing import Any, Iterable
+
+BUILD_WORDS_COUNT = 2
+_BITS_PER_WORD = 11  # 2048-word list
+_TOTAL_BITS = BUILD_WORDS_COUNT * _BITS_PER_WORD  # 22
+
+# The fields of LumenTest's ManifestFile with their defaults. LumenLabel's
+# ManifestFile has no ``version`` and no ``os``; they hash as null and "any".
+_FIELD_DEFAULTS: dict[str, Any] = {
+    "path": None,
+    "role": None,
+    "title": None,
+    "version": None,
+    "sha256": None,
+    "os": "any",
+}
+
+WORDLIST_PATH = Path(__file__).resolve().parent / "wordlist" / "bip39-english.txt"
+
+
+def _load_wordlist(path: Path) -> tuple[str, ...]:
+    words = tuple(path.read_text(encoding="utf-8").split())
+    if len(words) != 2048:
+        raise RuntimeError(f"expected 2048-word BIP39 wordlist, got {len(words)}")
+    return words
+
+
+_WORDLIST: tuple[str, ...] = _load_wordlist(WORDLIST_PATH)
+
+__all__ = ["BUILD_WORDS_COUNT", "content_digest", "build_words"]
+
+
+def _canonical_entry(entry: Any) -> dict[str, Any]:
+    """Reduces a ManifestFile model or a files[] dict to the canonical fields."""
+    if hasattr(entry, "model_dump"):
+        entry = entry.model_dump(mode="json")
+    return {key: entry.get(key, default) for key, default in _FIELD_DEFAULTS.items()}
+
+
+def content_digest(files: Iterable[Any]) -> str:
+    """SHA-256 hex digest over the canonical ``files[]`` entries, sorted by path."""
+    entries = sorted((_canonical_entry(f) for f in files), key=lambda f: f["path"])
+    digest = hashlib.sha256()
+    for obj in entries:
+        blob = json.dumps(
+            obj, sort_keys=True, separators=(",", ":"), ensure_ascii=False
+        ).encode("utf-8")
+        # JSON escapes newlines inside strings, so "\n" separates unambiguously.
+        digest.update(blob + b"\n")
+    return digest.hexdigest()
+
+
+def words_from_digest(digest: str) -> str:
+    """The two words for a :func:`content_digest` value."""
+    head = bytes.fromhex(digest)[:3]
+    value = int.from_bytes(head, "big") >> (8 * len(head) - _TOTAL_BITS)
+    return f"{_WORDLIST[value >> _BITS_PER_WORD]} {_WORDLIST[value & 0x7FF]}"
+
+
+def build_words(files: Iterable[Any]) -> str:
+    """Two BIP39 words for *files*. The manifest header is not hashed."""
+    return words_from_digest(content_digest(files))

lumenlabel/cli.py

@@ -0,0 +1,60 @@
+"""The ``lumenlabel`` command."""
+
+from __future__ import annotations
+
+import typer
+
+from . import __version__
+from .commands.api import api
+from .commands.auth import login, logout
+from .commands.label import label_app
+from .commands.station import station_app
+from .shared import GlobalOptions
+
+app = typer.Typer(
+    help=(
+        "Import labels into a LumenLabel station and inspect it, locally, on the "
+        "LAN or through the Fleet relay."
+    ),
+    no_args_is_help=True,
+)
+app.command("login")(login)
+app.command("logout")(logout)
+app.add_typer(label_app, name="label")
+app.add_typer(station_app, name="station")
+app.command("api")(api)
+
+
+def _version(value: bool) -> None:
+    if value:
+        typer.echo(__version__)
+        raise typer.Exit()
+
+
+@app.callback()
+def main(
+    ctx: typer.Context,
+    station: str = typer.Option(
+        None,
+        "--station",
+        "--base-url",
+        "-s",
+        envvar=["LUMENLABEL_STATION", "LUMENLABEL_URL"],
+        help="Station URL for this command (--base-url as in lumentest). "
+        "Default: the remembered station, else the local station API.",
+    ),
+    token: str = typer.Option(
+        None,
+        "--token",
+        envvar="LUMENLABEL_TOKEN",
+        help="Station token for a LAN URL. Default: the remembered one.",
+    ),
+    version: bool = typer.Option(
+        False,
+        "--version",
+        callback=_version,
+        is_eager=True,
+        help="Show the version and exit.",
+    ),
+) -> None:
+    ctx.obj = GlobalOptions(station=station, token=token)