lsdsk 1.0.0__py3-none-any.whl

lsdsk/__init__.py

@@ -0,0 +1,19 @@
+"""Public package surface: configuration and package metadata.
+
+lsdsk is a command-line tool, so its public Python surface is deliberately
+small. Everything a reader wants is behind the CLI or, for a program, behind
+``lsdsk <command> --format json``.
+"""
+
+from __future__ import annotations
+
+# Metadata
+from .__init__conf__ import print_info
+
+# Composition exports (wired adapters)
+from .composition import get_config
+
+__all__ = [
+    "get_config",
+    "print_info",
+]

lsdsk/__init__conf__.py

@@ -0,0 +1,90 @@
+"""Static package metadata surfaced to CLI commands and documentation.
+
+Purpose
+-------
+Expose the current project metadata as simple constants. These values are kept
+in sync with ``pyproject.toml`` by development automation (tests, push
+pipelines), so runtime code does not query packaging metadata.
+
+Contents
+--------
+* Module-level constants describing the published package.
+* :func:`print_info` rendering the constants for the CLI ``info`` command.
+
+System Role
+-----------
+Lives in the adapters/platform layer; CLI transports import these constants to
+present authoritative project information without invoking packaging APIs.
+"""
+
+from __future__ import annotations
+
+import sys
+
+__all__ = [
+    "LAYEREDCONF_APP",
+    "LAYEREDCONF_SLUG",
+    "LAYEREDCONF_VENDOR",
+    "author",
+    "author_email",
+    "homepage",
+    "name",
+    "print_info",
+    "shell_command",
+    "title",
+    "version",
+]
+
+#: Distribution name declared in ``pyproject.toml``.
+name = "lsdsk"
+#: Human-readable summary shown in CLI help output.
+title = "See your disks and controllers, and what is wrong with how they are connected"
+#: Current release version pulled from ``pyproject.toml`` by automation.
+version = "1.0.0"
+#: Repository homepage presented to users.
+homepage = "https://github.com/bitranox/lsdsk"
+#: Author attribution surfaced in CLI output.
+author = "bitranox"
+#: Contact email surfaced in CLI output.
+author_email = "bitranox@gmail.com"
+#: Console-script name published by the package.
+shell_command = "lsdsk"
+
+#: Vendor identifier for lib_layered_config paths (macOS/Windows)
+LAYEREDCONF_VENDOR: str = "bitranox"
+#: Application display name for lib_layered_config paths (macOS/Windows)
+LAYEREDCONF_APP: str = "lsdsk"
+#: Configuration slug for lib_layered_config Linux paths and environment variables
+LAYEREDCONF_SLUG: str = "lsdsk"
+
+
+def print_info() -> None:
+    """Print the summarised metadata block used by the CLI ``info`` command.
+
+    Why
+        Provides a single, auditable rendering function so documentation and
+        CLI output always match the system design reference.
+
+    Side Effects
+        Writes to ``stdout``.
+
+    Examples
+    --------
+    >>> print_info()  # doctest: +ELLIPSIS
+    Info for lsdsk:
+    ...
+    """
+
+    fields = [
+        ("name", name),
+        ("title", title),
+        ("version", version),
+        ("homepage", homepage),
+        ("author", author),
+        ("author_email", author_email),
+        ("shell_command", shell_command),
+    ]
+    pad = max(len(label) for label, _ in fields)
+    lines = [f"Info for {name}:", ""]
+    lines.extend(f"    {label.ljust(pad)} = {value}" for label, value in fields)
+    sys.stdout.write("\n".join(lines) + "\n")

lsdsk/__main__.py

@@ -0,0 +1,9 @@
+"""Module entry point for ``python -m lsdsk``."""
+
+from __future__ import annotations
+
+from .adapters.cli.main import main
+from .composition import build_production
+
+if __name__ == "__main__":
+    raise SystemExit(main(services_factory=build_production))

lsdsk/adapters/__init__.py

@@ -0,0 +1,14 @@
+"""Adapters layer - infrastructure and framework integrations.
+
+Contains adapter implementations that connect the application to external
+systems and frameworks (CLI, configuration, hardware, logging, rendering).
+
+Contents:
+    * :mod:`.config` - Configuration loading, deployment, and display
+    * :mod:`.logging` - Logging setup with lib_log_rich
+    * :mod:`.cli` - Click CLI framework integration
+"""
+
+from __future__ import annotations
+
+__all__: list[str] = []

lsdsk/adapters/cli/__init__.py

@@ -0,0 +1,80 @@
+"""CLI package providing the command-line interface.
+
+Re-exports all public symbols from submodules for convenient access.
+
+Contents:
+    * Click context helpers and traceback state management from :mod:`.context`
+    * Root command group from :mod:`.root`
+    * Entry point from :mod:`.main`
+    * All command functions from :mod:`.commands`
+
+System Role:
+    Acts as the public facade for the CLI subsystem. Consumers import from here
+    and remain insulated from internal module boundaries.
+"""
+
+from __future__ import annotations
+
+from .commands import (
+    cli_config,
+    cli_config_deploy,
+    cli_config_generate_examples,
+    cli_controllers,
+    cli_disks,
+    cli_fail,
+    cli_findings,
+    cli_health,
+    cli_info,
+    cli_logdemo,
+    cli_record,
+    cli_slots,
+    cli_smart,
+    cli_snapshot,
+    cli_topology,
+    cli_trend,
+    cli_tui,
+)
+from .constants import CLICK_CONTEXT_SETTINGS
+from .context import (
+    TracebackState,
+    apply_traceback_preferences,
+    restore_traceback_state,
+    snapshot_traceback_state,
+    store_cli_context,
+)
+from .main import main
+from .root import cli
+
+__all__ = [
+    # Constants
+    "CLICK_CONTEXT_SETTINGS",
+    # Traceback management
+    "TracebackState",
+    "apply_traceback_preferences",
+    # Root command
+    "cli",
+    # Commands
+    "cli_config",
+    "cli_config_deploy",
+    "cli_config_generate_examples",
+    "cli_controllers",
+    "cli_disks",
+    "cli_fail",
+    "cli_findings",
+    "cli_health",
+    "cli_info",
+    "cli_logdemo",
+    "cli_record",
+    "cli_slots",
+    "cli_smart",
+    "cli_snapshot",
+    "cli_topology",
+    "cli_trend",
+    "cli_tui",
+    # Entry point
+    "main",
+    "restore_traceback_state",
+    "snapshot_traceback_state",
+    # Context helpers
+    "store_cli_context",
+]

lsdsk/adapters/cli/commands/__init__.py

@@ -0,0 +1,49 @@
+"""CLI command implementations.
+
+Collects all subcommand functions and re-exports them for registration
+with the root CLI group.
+
+Contents:
+    * Info commands from :mod:`.info`
+    * Config commands from :mod:`.config`
+    * Logging commands from :mod:`.logging`
+    * Storage commands from :mod:`.scan`
+"""
+
+from __future__ import annotations
+
+from .config import cli_config, cli_config_deploy, cli_config_generate_examples
+from .history import cli_record, cli_trend
+from .info import cli_fail, cli_info
+from .logging import cli_logdemo
+from .scan import (
+    cli_controllers,
+    cli_disks,
+    cli_findings,
+    cli_health,
+    cli_slots,
+    cli_smart,
+    cli_snapshot,
+    cli_topology,
+    cli_tui,
+)
+
+__all__ = [
+    "cli_config",
+    "cli_config_deploy",
+    "cli_config_generate_examples",
+    "cli_controllers",
+    "cli_disks",
+    "cli_fail",
+    "cli_findings",
+    "cli_health",
+    "cli_info",
+    "cli_logdemo",
+    "cli_record",
+    "cli_slots",
+    "cli_smart",
+    "cli_snapshot",
+    "cli_topology",
+    "cli_trend",
+    "cli_tui",
+]