sdmxlib-cli 0.72.0__py3-none-any.whl

sdmxlib_cli/__init__.py

@@ -0,0 +1,103 @@
+"""``sdmxlib``: the command line over the library's bundle tools (GH-67).
+
+A separate distribution, ``sdmxlib-cli``, so ``sdmxlib`` itself never depends on
+typer. Each command is a thin wrapper: the work is the library's, and is
+tested there.
+"""
+
+from pathlib import Path
+from typing import Annotated
+
+import typer
+
+import sdmxlib as sl
+from sdmxlib.api.providers import ProviderInfo
+from sdmxlib.bundle import check_bundle, fetch_bundle
+from sdmxlib.model.dataflow import Dataflow
+from sdmxlib.model.urn import SdmxUrn
+
+app = typer.Typer(help="sdmxlib from the command line.", no_args_is_help=True)
+bundle = typer.Typer(help="Published SDMX bundles.", no_args_is_help=True)
+app.add_typer(bundle, name="bundle")
+
+
+@bundle.command("check")
+def check(
+    path: Annotated[Path, typer.Argument(help="The bundle directory.")],
+    *,
+    references: Annotated[
+        bool,
+        typer.Option(
+            "--references/--no-references",
+            help="Check that every reference resolves within the bundle (loads every artefact; the slow part).",
+        ),
+    ] = True,
+) -> None:
+    """Check a published bundle against its manifest and against itself.
+
+    Prints each finding and what was checked. Exits 1 if anything was found.
+
+    Raises:
+        Exit: With status 1 when the bundle has findings, 0 otherwise.
+    """
+    report = check_bundle(path, references=references)
+    for finding in report.findings:
+        typer.echo(str(finding))
+    found = len(report.findings)
+    typer.echo(f"{path}: {found} finding{'' if found == 1 else 's'}; checked {', '.join(report.checked)}")
+    raise typer.Exit(code=0 if report.ok else 1)
+
+
+def _source(text: str) -> ProviderInfo | str:
+    """A `Provider` by name (``ECB``, case-insensitive), else the text as a REST endpoint URL."""
+    if "://" in text:
+        return text
+    try:
+        return sl.Provider[text.upper()]
+    except (AttributeError, KeyError) as exc:
+        msg = f"{text!r} is neither a known provider nor a URL"
+        raise typer.BadParameter(msg) from exc
+
+
+def _flow(text: str) -> SdmxUrn[Dataflow]:
+    """A dataflow as ``AGENCY:ID(VERSION)``, ``AGENCY:ID`` (latest), or a full URN."""
+    if text.startswith("urn:"):
+        return Dataflow.parse_urn(text)
+    agency, _, rest = text.partition(":")
+    flow_id, _, version = rest.partition("(")
+    if not agency or not flow_id:
+        msg = f"{text!r} is not AGENCY:ID(VERSION), AGENCY:ID or a dataflow URN"
+        raise typer.BadParameter(msg)
+    return Dataflow.urn_for(agency=agency, id=flow_id, version=version.rstrip(")") or "latest")
+
+
+@bundle.command("fetch")
+def fetch(
+    source: Annotated[str, typer.Argument(help="A provider (ECB, ESTAT, BIS, OECD, ...) or a REST endpoint URL.")],
+    flow: Annotated[str, typer.Argument(help="The dataflow: AGENCY:ID(VERSION), AGENCY:ID, or a URN.")],
+    path: Annotated[Path, typer.Argument(help="The bundle directory to create; must not exist or be empty.")],
+    *,
+    key: Annotated[str | None, typer.Option(help="SDMX key, e.g. M.USD+GBP.EUR.SP00.A.")] = None,
+    start: Annotated[str | None, typer.Option(help="Inclusive startPeriod.")] = None,
+    end: Annotated[str | None, typer.Option(help="Inclusive endPeriod.")] = None,
+    structures_only: Annotated[bool, typer.Option(help="Fetch the structures and no observations.")] = False,
+    api: Annotated[str, typer.Option(help="REST API version of a URL source.")] = "2.1",
+    source_id: Annotated[str | None, typer.Option(help="Registry id of a URL source, recorded as provenance.")] = None,
+) -> None:
+    """Fetch one dataflow, narrowed by key and period, into a new published bundle.
+
+    Prints the bundle's token and what it holds.
+    """
+    manifest = fetch_bundle(
+        _source(source),
+        _flow(flow),
+        path,
+        key=key,
+        start=start,
+        end=end,
+        structures_only=structures_only,
+        api=api,
+        source_id=source_id,
+    )
+    counts = ", ".join(f"{b.observations} observations" for b in manifest.bindings) or "structures only"
+    typer.echo(f"{path}: {manifest.bundle_id}, {counts}; token {manifest.token}")

sdmxlib_cli-0.72.0.dist-info/METADATA

@@ -0,0 +1,37 @@
+Metadata-Version: 2.3
+Name: sdmxlib-cli
+Version: 0.72.0
+Summary: sdmxlib from the command line: check SDMX bundles
+Keywords: sdmx,statistics,metadata,cli
+Author: gabrielgellner
+Author-email: gabrielgellner <gabrielgellner@gmail.com>
+License: Apache-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: sdmxlib==0.72.0
+Requires-Dist: typer>=0.27.3,<0.28
+Requires-Python: >=3.14
+Project-URL: Homepage, https://github.com/StatCat-Suite/sdmxlib
+Project-URL: Repository, https://github.com/StatCat-Suite/sdmxlib
+Project-URL: Documentation, https://statcat-suite.github.io/sdmxlib
+Project-URL: Changelog, https://github.com/StatCat-Suite/sdmxlib/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+# sdmxlib-cli
+
+[sdmxlib](https://github.com/StatCat-Suite/sdmxlib) from the command line. A
+separate install, so the library itself carries no CLI dependency:
+
+```sh
+uv tool install sdmxlib-cli
+sdmxlib bundle check path/to/bundle
+```
+
+`sdmxlib bundle check` runs `sdmxlib.bundle.check_bundle`: the manifest, every
+file's checksum, the DuckLake catalog, the bindings' observation counts, and
+the structural closure (`--no-references` skips that, the slow part). It prints
+each finding and exits 1 if there are any.
+
+Released with sdmxlib, at the same version.

sdmxlib_cli-0.72.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+sdmxlib_cli/__init__.py,sha256=MNznl5-Z7heSIJCFlHLlI3kxIL4ZjkhKrWZAQrNZ93k,4118
+sdmxlib_cli-0.72.0.dist-info/WHEEL,sha256=si2p8vW03RnhyBnhWl4tj-ObJa78SpE-c9HsEtblGR0,80
+sdmxlib_cli-0.72.0.dist-info/entry_points.txt,sha256=nni5NOVMshJOBOByM9CIsQ1jlf-XIJSbu6j1Jmy6bxw,45
+sdmxlib_cli-0.72.0.dist-info/METADATA,sha256=H1DqFhYuYl9fmn7-Z3hbrwHYVK6FuyrqWFqXFcZrfhE,1406
+sdmxlib_cli-0.72.0.dist-info/RECORD,,

sdmxlib_cli-0.72.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.13.5
+Root-Is-Purelib: true
+Tag: py3-none-any

sdmxlib_cli-0.72.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+sdmxlib = sdmxlib_cli:app
+