pikvm-auto 0.3.0__py3-none-any.whl

pikvm_auto/__init__.py

@@ -0,0 +1,35 @@
+"""pikvm-auto package.
+
+pikvmautomation, library, and ansible modules
+"""
+
+from __future__ import annotations
+
+from pikvm_auto._internal.cli import get_parser, main
+from pikvm_auto._internal.commands.hid import (
+    HIDAction,
+    HIDClient,
+    actions_from_yaml,
+    canonical_key,
+)
+from pikvm_auto._internal.commands.info import run_info
+from pikvm_auto._internal.config import PiKVMSettings
+
+__all__: list[str] = [
+    "HIDAction",
+    "HIDClient",
+    "PiKVMSettings",
+    "actions_from_yaml",
+    "canonical_key",
+    "get_parser",
+    "main",
+    "run_info",
+]
+
+from pikvm_auto._internal.commands.screenshot import (
+    ScreenMatch,
+    ScreenshotClient,
+    fuzzy_score,
+)
+
+__all__ += ["ScreenMatch", "ScreenshotClient", "fuzzy_score"]

pikvm_auto/__main__.py

@@ -0,0 +1,14 @@
+"""Entry-point module, in case you use `python -m pikvm_auto`.
+
+Why does this file exist, and why `__main__`? For more info, read:
+
+- https://www.python.org/dev/peps/pep-0338/
+- https://docs.python.org/3/using/cmdline.html#cmdoption-m
+"""
+
+import sys
+
+from pikvm_auto._internal.cli import main
+
+if __name__ == "__main__":
+    sys.exit(main(sys.argv[1:]))

pikvm_auto/_internal/cli.py

@@ -0,0 +1,97 @@
+# Why does this file exist, and why not put this in `__main__`?
+#
+# You might be tempted to import things from `__main__` later,
+# but that will cause problems: the code will get executed twice:
+#
+# - When you run `python -m pikvm_auto` python will execute
+#   `__main__.py` as a script. That means there won't be any
+#   `pikvm_auto.__main__` in `sys.modules`.
+# - When you import `__main__` it will get executed again (as a module) because
+#   there's no `pikvm_auto.__main__` in `sys.modules`.
+
+from __future__ import annotations
+
+import argparse
+import sys
+from typing import Any
+
+from pikvm_auto._internal import debug
+from pikvm_auto._internal.commands.info import run_info
+from pikvm_auto._internal.config import PiKVMSettings
+
+
+class _DebugInfo(argparse.Action):
+    def __init__(self, nargs: int | str | None = 0, **kwargs: Any) -> None:
+        super().__init__(nargs=nargs, **kwargs)
+
+    def __call__(self, *args: Any, **kwargs: Any) -> None:  # noqa: ARG002
+        debug._print_debug_info()
+        sys.exit(0)
+
+
+def _add_connection_args(parser: argparse.ArgumentParser) -> None:
+    group = parser.add_argument_group("connection")
+    group.add_argument("--host", help="PiKVM hostname or IP.")
+    group.add_argument("--user", help="PiKVM username (default: admin).")
+    group.add_argument("--password", help="PiKVM password.")
+    group.add_argument("--schema", help="Protocol: http or https (default: https).")
+    group.add_argument("--cert-trusted", action="store_true", help="Trust SSL certificate.")
+
+
+def get_parser() -> argparse.ArgumentParser:
+    """Return the CLI argument parser.
+
+    Returns:
+        An argparse parser.
+    """
+    parser = argparse.ArgumentParser(prog="pikvm-auto")
+    parser.add_argument("-V", "--version", action="version", version=f"%(prog)s {debug._get_version()}")
+    parser.add_argument("--debug-info", action=_DebugInfo, help="Print debug information.")
+
+    subparsers = parser.add_subparsers(dest="command")
+
+    info_parser = subparsers.add_parser("info", help="Show PiKVM system info and health status.")
+    _add_connection_args(info_parser)
+
+    return parser
+
+
+def _build_settings(opts: argparse.Namespace) -> PiKVMSettings:
+    overrides: dict[str, Any] = {}
+    if opts.host:
+        overrides["host"] = opts.host
+    if opts.user:
+        overrides["user"] = opts.user
+    if opts.password:
+        overrides["password"] = opts.password
+    if opts.schema:
+        overrides["schema_"] = opts.schema
+    if opts.cert_trusted:
+        overrides["cert_trusted"] = opts.cert_trusted
+    return PiKVMSettings(**overrides)
+
+
+def main(args: list[str] | None = None) -> int:
+    """Run the main program.
+
+    This function is executed when you type `pikvm-auto` or `python -m pikvm_auto`.
+
+    Parameters:
+        args: Arguments passed from the command line.
+
+    Returns:
+        An exit code.
+    """
+    parser = get_parser()
+    opts = parser.parse_args(args=args)
+
+    if opts.command is None:
+        parser.print_help()
+        return 0
+
+    if opts.command == "info":
+        settings = _build_settings(opts)
+        client = settings.create_client()
+        return run_info(client)
+
+    return 0

pikvm_auto/_internal/commands/hid.py

@@ -0,0 +1,297 @@
+# HID input library for PiKVM.
+#
+# Provides a high-level interface for sending keyboard input via the kvmd HTTP
+# API (key taps, chorded shortcuts, text typing, and timed sequences).
+#
+# HTTP wiring
+# -----------
+# pikvm-lib 0.5.0's BuildPiKVM does NOT use a requests.Session. Upstream calls
+# the module-level requests.get / requests.post functions directly with
+# headers=self.headers and verify=self.certificate_trusted on every call.
+# HIDClient follows the same pattern: it reads headers, hostname, schema, and
+# certificate_trusted from the passed PiKVM instance and calls the
+# module-level requests.post directly. The PiKVM object exposes no persistent
+# HTTP session attribute. Tests must monkeypatch
+# pikvm_auto._internal.commands.hid.requests.post rather than any session.
+#
+# Modifier key aliases
+# --------------------
+# Short modifier aliases (ctrl, alt, shift, meta/win) default to the LEFT
+# variant of the corresponding kvmd key code (ControlLeft, AltLeft, ShiftLeft,
+# MetaLeft). To target the right-hand modifier, pass the canonical name
+# directly (ControlRight, AltRight, ShiftRight, MetaRight).
+
+from __future__ import annotations
+
+import time
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, Literal
+
+import requests
+
+if TYPE_CHECKING:
+    from pikvm_lib.pikvm import PiKVM
+
+
+@dataclass
+class HIDAction:
+    """A single HID action in a scripted input sequence.
+
+    Fields:
+      kind:    one of "key", "shortcut", "text", "wait".
+      key:     single key name (used when ``kind == "key"``).
+      keys:    list of key names for a chord (used when ``kind == "shortcut"``).
+      text:    text to type (used when ``kind == "text"``).
+      seconds: delay in seconds (used when ``kind == "wait"``).
+    """
+
+    kind: Literal["key", "shortcut", "text", "wait"]
+    key: str | None = None
+    keys: list[str] | None = None
+    text: str | None = None
+    seconds: float | None = None
+
+
+# Friendly alias → kvmd canonical key code.
+# Modifier aliases default to the LEFT variant; use the canonical name to
+# target the right-hand modifier.
+_KEY_ALIASES: dict[str, str] = {
+    # Function keys F1..F12
+    **{f"f{i}": f"F{i}" for i in range(1, 13)},
+    # Arrow keys
+    "up": "ArrowUp",
+    "down": "ArrowDown",
+    "left": "ArrowLeft",
+    "right": "ArrowRight",
+    # Common singles
+    "enter": "Enter",
+    "return": "Enter",
+    "esc": "Escape",
+    "escape": "Escape",
+    "tab": "Tab",
+    "del": "Delete",
+    "delete": "Delete",
+    "backspace": "Backspace",
+    "space": "Space",
+    "home": "Home",
+    "end": "End",
+    "pageup": "PageUp",
+    "pagedown": "PageDown",
+    # Modifiers default to LEFT variant
+    "ctrl": "ControlLeft",
+    "alt": "AltLeft",
+    "shift": "ShiftLeft",
+    "meta": "MetaLeft",
+    "win": "MetaLeft",
+}
+
+# Canonical key codes that do not share a common prefix (Key*, Arrow*, Digit*,
+# Numpad*) but are still valid passthroughs.
+_CANONICAL_SINGLES: frozenset[str] = frozenset(
+    {
+        "Enter",
+        "Escape",
+        "Tab",
+        "Delete",
+        "Backspace",
+        "Space",
+        "Home",
+        "End",
+        "PageUp",
+        "PageDown",
+        "Insert",
+        "CapsLock",
+        "ControlLeft",
+        "ControlRight",
+        "AltLeft",
+        "AltRight",
+        "ShiftLeft",
+        "ShiftRight",
+        "MetaLeft",
+        "MetaRight",
+        "Minus",
+        "Equal",
+        "BracketLeft",
+        "BracketRight",
+        "Backslash",
+        "Semicolon",
+        "Quote",
+        "Backquote",
+        "Comma",
+        "Period",
+        "Slash",
+    },
+)
+
+_CANONICAL_PREFIXES: tuple[str, ...] = ("Key", "Arrow", "Digit", "Numpad")
+
+
+def canonical_key(key: str) -> str:
+    """Return the kvmd canonical code for ``key``.
+
+    Lookup order:
+      1. Friendly alias (case-insensitive) — e.g. ``f11`` → ``KeyF11``.
+      2. Canonical passthrough — names with a known prefix (``Key*``,
+         ``Arrow*``, ``Digit*``, ``Numpad*``) or known singles (``Enter``,
+         ``ControlRight``, …) are returned unchanged.
+
+    Raises ``ValueError`` if the key cannot be resolved.
+    """
+    if not isinstance(key, str) or not key:
+        raise ValueError(f"unknown key: {key!r}")
+
+    lower = key.lower()
+    if lower in _KEY_ALIASES:
+        return _KEY_ALIASES[lower]
+
+    if key in _CANONICAL_SINGLES:
+        return key
+    if key.startswith(_CANONICAL_PREFIXES):
+        return key
+
+    raise ValueError(f"unknown key: {key!r}")
+
+
+class HIDClient:
+    """High-level HID input client for PiKVM.
+
+    Reads ``headers``, ``hostname``, ``schema``, and ``certificate_trusted``
+    from the passed ``PiKVM`` instance and calls the module-level
+    ``requests.post`` directly (matching pikvm-lib's own pattern — see module
+    docstring).
+    """
+
+    def __init__(self, pikvm: PiKVM) -> None:
+        self._headers = pikvm.headers
+        self._base = f"{pikvm.schema}://{pikvm.hostname}"
+        self._verify = pikvm.certificate_trusted
+
+    def _send_key(self, code: str, state: str) -> None:
+        """POST a single key press or release event to kvmd.
+
+        ``state`` is the string ``"true"`` (press) or ``"false"`` (release) —
+        kvmd's API spec documents the ``state`` query parameter as a boolean,
+        serialised as a lowercase string.
+        """
+        resp = requests.post(
+            f"{self._base}/api/hid/events/send_key",
+            params={"key": code, "state": state},
+            headers=self._headers,
+            verify=self._verify,
+            timeout=10,
+        )
+        resp.raise_for_status()
+
+    def tap(self, key: str) -> None:
+        """Press and release a single key."""
+        code = canonical_key(key)
+        self._send_key(code, "true")
+        self._send_key(code, "false")
+
+    def press(self, key: str, *, hold_ms: int = 50) -> None:
+        """Press a key, hold it for ``hold_ms`` milliseconds, then release."""
+        code = canonical_key(key)
+        self._send_key(code, "true")
+        time.sleep(hold_ms / 1000)
+        self._send_key(code, "false")
+
+    def shortcut(self, keys: list[str]) -> None:
+        """Send a chord atomically via kvmd's ``/api/hid/events/send_shortcut``.
+
+        Server-side timing is more reliable than a synthesised press/release
+        sequence, so this delegates the entire chord to kvmd.
+        """
+        if not keys:
+            raise ValueError("shortcut() requires at least one key")
+        codes = ",".join(canonical_key(k) for k in keys)
+        resp = requests.post(
+            f"{self._base}/api/hid/events/send_shortcut",
+            params={"keys": codes},
+            headers=self._headers,
+            verify=self._verify,
+            timeout=10,
+        )
+        resp.raise_for_status()
+
+    def type_text(self, text: str, *, slow: bool = False) -> None:
+        """Type a string via ``/api/hid/print``.
+
+        ``limit=0`` means unlimited length. ``slow=True`` adds inter-character
+        delays server-side for flaky guest input handling.
+        """
+        if not text:
+            raise ValueError("type_text() requires non-empty text")
+        params: dict[str, str | int] = {"limit": 0}
+        if slow:
+            params["slow"] = "true"
+        resp = requests.post(
+            f"{self._base}/api/hid/print",
+            params=params,
+            data=text,
+            headers=self._headers,
+            verify=self._verify,
+            timeout=30,
+        )
+        resp.raise_for_status()
+
+    def play(self, actions: list[HIDAction]) -> None:
+        """Execute a sequence of HID actions in order.
+
+        Each action is dispatched by ``kind``:
+          - ``"wait"`` → ``time.sleep(a.seconds or 0)``
+          - ``"key"`` → ``self.tap(a.key)`` (requires ``a.key``)
+          - ``"shortcut"`` → ``self.shortcut(a.keys)`` (requires ``a.keys``)
+          - ``"text"`` → ``self.type_text(a.text)`` (requires ``a.text``)
+        """
+        for a in actions:
+            if a.kind == "wait":
+                time.sleep(a.seconds or 0)
+            elif a.kind == "key":
+                if a.key is None:
+                    raise ValueError("HIDAction(kind='key') requires 'key'")
+                self.tap(a.key)
+            elif a.kind == "shortcut":
+                if a.keys is None:
+                    raise ValueError("HIDAction(kind='shortcut') requires 'keys'")
+                self.shortcut(a.keys)
+            elif a.kind == "text":
+                if a.text is None:
+                    raise ValueError("HIDAction(kind='text') requires 'text'")
+                self.type_text(a.text)
+            else:
+                raise ValueError(f"unknown HIDAction kind: {a.kind!r}")
+
+
+_VALID_KINDS: frozenset[str] = frozenset({"key", "shortcut", "text", "wait"})
+
+
+def actions_from_yaml(raw: list[dict]) -> list[HIDAction]:
+    """Build a list of ``HIDAction`` from raw dicts (e.g. parsed YAML).
+
+    Each dict must have a valid ``kind`` plus the relevant payload fields
+    (``key``, ``keys``, ``text``, ``seconds``). Unknown kinds raise
+    ``ValueError`` with the offending item index.
+    """
+    out: list[HIDAction] = []
+    for i, item in enumerate(raw):
+        kind = item.get("kind")
+        if kind not in _VALID_KINDS:
+            raise ValueError(f"unknown HIDAction kind: {kind!r} (item {i})")
+        if kind == "key" and not item.get("key"):
+            raise ValueError(f"HIDAction kind=key requires 'key' (item {i})")
+        if kind == "shortcut" and not item.get("keys"):
+            raise ValueError(f"HIDAction kind=shortcut requires 'keys' (item {i})")
+        if kind == "text" and item.get("text") is None:
+            raise ValueError(f"HIDAction kind=text requires 'text' (item {i})")
+        if kind == "wait" and item.get("seconds") is None:
+            raise ValueError(f"HIDAction kind=wait requires 'seconds' (item {i})")
+        out.append(
+            HIDAction(
+                kind=kind,
+                key=item.get("key"),
+                keys=item.get("keys"),
+                text=item.get("text"),
+                seconds=item.get("seconds"),
+            ),
+        )
+    return out

pikvm_auto/_internal/commands/info.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+import json
+
+from pikvm_lib.pikvm import PiKVM
+
+
+def run_info(client: PiKVM) -> int:
+    system_info = client.get_system_info()
+    atx_state = client.get_atx_state()
+    streamer_state = client.get_streamer_state()
+
+    _print_section("System Info", system_info.get("result", {}))
+    _print_section("ATX / Power Status", atx_state.get("result", {}))
+    _print_section("Streamer Status", streamer_state.get("result", {}))
+
+    return 0
+
+
+def _print_section(title: str, data: dict) -> None:
+    print(f"\n{'=' * 40}")
+    print(f"  {title}")
+    print(f"{'=' * 40}")
+    print(json.dumps(data, indent=2))

pikvm_auto/_internal/commands/screenshot.py

@@ -0,0 +1,210 @@
+# Screenshot + OCR library for PiKVM.
+#
+# Covers /api/streamer/snapshot in both raw-frame and OCR modes, plus a
+# fuzzy-match polling helper (wait_for_text).
+#
+# HTTP wiring
+# -----------
+# pikvm-lib 0.5.0's BuildPiKVM does NOT use a requests.Session. Upstream calls
+# the module-level requests.get / requests.post functions directly with
+# headers=self.headers and verify=self.certificate_trusted on every call.
+# ScreenshotClient follows the same pattern: it reads headers, hostname,
+# schema, and certificate_trusted from the passed PiKVM instance and calls
+# the module-level requests.get directly. Tests must monkeypatch
+# pikvm_auto._internal.commands.screenshot.requests.get rather than any
+# session attribute.
+
+from __future__ import annotations
+
+import time
+from dataclasses import dataclass, field
+from datetime import datetime, timezone
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+import requests
+
+if TYPE_CHECKING:
+    from pikvm_lib.pikvm import PiKVM
+
+try:
+    from rapidfuzz import fuzz as _fuzz
+
+    _HAVE_RAPIDFUZZ = True
+except ImportError:
+    _HAVE_RAPIDFUZZ = False
+    import difflib
+
+
+@dataclass
+class ScreenMatch:
+    """Result of a fuzzy screen-text match.
+
+    Fields:
+      matched:  True if the final score was at or above the threshold.
+      score:    Final similarity score in [0.0, 1.0].
+      expected: Expected text that was searched for.
+      ocr_text: Last OCR'd screen text observed.
+      elapsed:  Total time spent polling, in seconds.
+      captures: Any screenshot files saved during polling.
+    """
+
+    matched: bool
+    score: float
+    expected: str
+    ocr_text: str
+    elapsed: float
+    captures: list[Path] = field(default_factory=list)
+
+
+def fuzzy_score(
+    expected: str,
+    actual: str,
+    *,
+    case_sensitive: bool = False,
+) -> float:
+    """Return a substring-aware fuzzy similarity score in [0.0, 1.0].
+
+    Uses ``rapidfuzz.fuzz.partial_ratio`` when available (handles substring
+    matches and OCR character-level errors). Falls back to a ``difflib``
+    ``SequenceMatcher`` sliding window if rapidfuzz isn't installed.
+    """
+    if not expected:
+        return 1.0
+    if not actual:
+        return 0.0
+    e, a = (expected, actual) if case_sensitive else (expected.lower(), actual.lower())
+
+    if _HAVE_RAPIDFUZZ:
+        return _fuzz.partial_ratio(e, a) / 100.0
+
+    # Fallback: sliding window of len(expected) over actual
+    elen = len(e)
+    if elen >= len(a):
+        return difflib.SequenceMatcher(None, e, a).ratio()
+    best = 0.0
+    for i in range(len(a) - elen + 1):
+        chunk = a[i : i + elen]
+        r = difflib.SequenceMatcher(None, e, chunk).ratio()
+        best = max(best, r)
+        if best >= 1.0:
+            break
+    return best
+
+
+class ScreenshotClient:
+    """Client for /api/streamer/snapshot + OCR.
+
+    Reads ``headers``, ``hostname``, ``schema``, and ``certificate_trusted``
+    from the passed ``PiKVM`` instance and calls the module-level
+    ``requests.get`` directly (matching pikvm-lib's own pattern — see the
+    module comment block at the top of this file).
+    """
+
+    def __init__(self, pikvm: PiKVM) -> None:
+        self._headers = pikvm.headers
+        self._base = f"{pikvm.schema}://{pikvm.hostname}"
+        self._verify = pikvm.certificate_trusted
+
+    def capture(self, *, ocr: bool = False) -> bytes:
+        """Fetch a screenshot via ``/api/streamer/snapshot``.
+
+        With ``ocr=True`` the response Content-Type is ``text/plain`` (the
+        kvmd OCR result); otherwise it is ``image/jpeg`` binary data.
+        """
+        params: dict[str, str] = {}
+        params["allow_offline"] = "1"
+        if ocr:
+            params["ocr"] = "true"
+        resp = requests.get(
+            f"{self._base}/api/streamer/snapshot",
+            params=params,
+            headers=self._headers,
+            verify=self._verify,
+            timeout=30,
+        )
+        resp.raise_for_status()
+        return resp.content
+
+    def capture_to(self, path: Path | str) -> Path:
+        """Capture and save to disk. Returns the resolved ``Path``.
+
+        Missing parent directories are created automatically.
+        """
+        if not path:
+            raise ValueError("capture_to() requires a non-empty path")
+        p = Path(path)
+        p.parent.mkdir(parents=True, exist_ok=True)
+        p.write_bytes(self.capture())
+        return p
+
+    def capture_text(self) -> str:
+        """Capture the screen and return the OCR'd text."""
+        return self.capture(ocr=True).decode("utf-8", errors="replace")
+
+    def wait_for_text(
+        self,
+        expected: str,
+        *,
+        threshold: float = 0.9,
+        timeout: float = 60.0,
+        interval: float = 1.0,
+        capture_dir: Path | None = None,
+        case_sensitive: bool = False,
+    ) -> ScreenMatch:
+        """Poll OCR until fuzzy_score(expected, screen) >= threshold or timeout.
+
+        Returns a ``ScreenMatch`` with the ``matched`` flag, final score, the
+        last OCR text observed, total elapsed seconds, and any screenshot
+        files saved to ``capture_dir``.
+        """
+        if not expected:
+            raise ValueError("wait_for_text() requires non-empty expected text")
+        if not 0.0 <= threshold <= 1.0:
+            raise ValueError(f"threshold must be in [0.0, 1.0], got {threshold}")
+        if timeout < 0:
+            raise ValueError(f"timeout must be non-negative, got {timeout}")
+        if interval <= 0:
+            raise ValueError(f"interval must be positive, got {interval}")
+        start = time.monotonic()
+        deadline = start + timeout
+        captures: list[Path] = []
+        attempt = 0
+
+        while True:
+            attempt += 1
+            try:
+                text = self.capture_text()
+            except requests.RequestException:
+                text = ""
+            score = fuzzy_score(expected, text, case_sensitive=case_sensitive)
+
+            if capture_dir is not None:
+                stamp = datetime.now(timezone.utc).strftime("%Y%m%dT%H%M%S")
+                p = Path(capture_dir) / f"{stamp}-{attempt:03d}.jpeg"
+                try:
+                    self.capture_to(p)
+                    captures.append(p)
+                except requests.RequestException:
+                    pass
+
+            if score >= threshold:
+                return ScreenMatch(
+                    matched=True,
+                    score=score,
+                    expected=expected,
+                    ocr_text=text,
+                    elapsed=time.monotonic() - start,
+                    captures=captures,
+                )
+
+            if time.monotonic() >= deadline:
+                return ScreenMatch(
+                    matched=False,
+                    score=score,
+                    expected=expected,
+                    ocr_text=text,
+                    elapsed=time.monotonic() - start,
+                    captures=captures,
+                )
+            time.sleep(interval)

pikvm_auto/_internal/config.py

@@ -0,0 +1,63 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any, ClassVar
+
+from pikvm_lib.pikvm import PiKVM
+from pydantic import Field
+from pydantic_settings import BaseSettings, PydanticBaseSettingsSource, SettingsConfigDict, TomlConfigSettingsSource
+
+
+class PiKVMSettings(BaseSettings):
+    """Settings for connecting to a PiKVM device.
+
+    Supports three configuration sources (highest priority first):
+    1. Direct kwargs (CLI flag overrides)
+    2. PIKVM_* environment variables
+    3. Config file at ~/.config/pikvm-auto/config.toml
+    """
+
+    _toml_path: ClassVar[Path] = Path.home() / ".config" / "pikvm-auto" / "config.toml"
+
+    model_config = SettingsConfigDict(
+        env_prefix="PIKVM_",
+    )
+
+    host: str
+    user: str = "admin"
+    password: str
+    schema_: str = Field("https", alias="PIKVM_SCHEMA", validation_alias="PIKVM_SCHEMA")
+    cert_trusted: bool = False
+
+    @classmethod
+    def settings_customise_sources(
+        cls,
+        settings_cls: type[BaseSettings],
+        init_settings: PydanticBaseSettingsSource,
+        env_settings: PydanticBaseSettingsSource,
+        dotenv_settings: PydanticBaseSettingsSource,
+        file_secret_settings: PydanticBaseSettingsSource,
+        **kwargs: Any,
+    ) -> tuple[PydanticBaseSettingsSource, ...]:
+        """Customise settings sources to include TOML config file.
+
+        Priority (highest to lowest):
+        1. init_settings (direct kwargs / CLI overrides)
+        2. env_settings (PIKVM_* environment variables)
+        3. TOML config file (~/.config/pikvm-auto/config.toml)
+        """
+        toml_source = TomlConfigSettingsSource(
+            settings_cls,
+            toml_file=cls._toml_path,
+        )
+        return init_settings, env_settings, toml_source
+
+    def create_client(self) -> PiKVM:
+        """Create a PiKVM client instance from the current settings."""
+        return PiKVM(
+            hostname=self.host,
+            username=self.user,
+            password=self.password,
+            schema=self.schema_,
+            cert_trusted=self.cert_trusted,
+        )

pikvm_auto/_internal/debug.py

@@ -0,0 +1,107 @@
+from __future__ import annotations
+
+import os
+import platform
+import sys
+from dataclasses import dataclass
+from importlib import metadata
+
+
+@dataclass
+class _Variable:
+    """Dataclass describing an environment variable."""
+
+    name: str
+    """Variable name."""
+    value: str
+    """Variable value."""
+
+
+@dataclass
+class _Package:
+    """Dataclass describing a Python package."""
+
+    name: str
+    """Package name."""
+    version: str
+    """Package version."""
+
+
+@dataclass
+class _Environment:
+    """Dataclass to store environment information."""
+
+    interpreter_name: str
+    """Python interpreter name."""
+    interpreter_version: str
+    """Python interpreter version."""
+    interpreter_path: str
+    """Path to Python executable."""
+    platform: str
+    """Operating System."""
+    packages: list[_Package]
+    """Installed packages."""
+    variables: list[_Variable]
+    """Environment variables."""
+
+
+def _interpreter_name_version() -> tuple[str, str]:
+    if hasattr(sys, "implementation"):
+        impl = sys.implementation.version
+        version = f"{impl.major}.{impl.minor}.{impl.micro}"
+        kind = impl.releaselevel
+        if kind != "final":
+            version += kind[0] + str(impl.serial)
+        return sys.implementation.name, version
+    return "", "0.0.0"
+
+
+def _get_version(dist: str = "pikvm-auto") -> str:
+    """Get version of the given distribution.
+
+    Parameters:
+        dist: A distribution name.
+
+    Returns:
+        A version number.
+    """
+    try:
+        return metadata.version(dist)
+    except metadata.PackageNotFoundError:
+        return "0.0.0"
+
+
+def _get_debug_info() -> _Environment:
+    """Get debug/environment information.
+
+    Returns:
+        Environment information.
+    """
+    py_name, py_version = _interpreter_name_version()
+    packages = ["pikvm-auto"]
+    variables = ["PYTHONPATH", *[var for var in os.environ if var.startswith("PIKVM_AUTO")]]
+    return _Environment(
+        interpreter_name=py_name,
+        interpreter_version=py_version,
+        interpreter_path=sys.executable,
+        platform=platform.platform(),
+        variables=[_Variable(var, val) for var in variables if (val := os.getenv(var))],
+        packages=[_Package(pkg, _get_version(pkg)) for pkg in packages],
+    )
+
+
+def _print_debug_info() -> None:
+    """Print debug/environment information."""
+    info = _get_debug_info()
+    print(f"- __System__: {info.platform}")
+    print(f"- __Python__: {info.interpreter_name} {info.interpreter_version} ({info.interpreter_path})")
+    print("- __Environment variables__:")
+    for var in info.variables:
+        print(f"  - `{var.name}`: `{var.value}`")
+    print("- __Installed packages__:")
+    for pkg in info.packages:
+        print(f"  - `{pkg.name}` v{pkg.version}")
+
+
+if __name__ == "__main__":
+    _print_debug_info()

pikvm_auto-0.3.0.dist-info/METADATA

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: pikvm-auto
+Version: 0.3.0
+Summary: pikvmautomation, library, and ansible modules
+Author-Email: KettleOfKetchup <kettleofketchup@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://kettleofketchup.github.io/pikvm-auto
+Project-URL: Documentation, https://kettleofketchup.github.io/pikvm-auto
+Project-URL: Changelog, https://kettleofketchup.github.io/pikvm-auto/changelog
+Project-URL: Repository, https://github.com/kettleofketchup/pikvm-auto
+Project-URL: Issues, https://github.com/kettleofketchup/pikvm-auto/issues
+Project-URL: Discussions, https://github.com/kettleofketchup/pikvm-auto/discussions
+Project-URL: Gitter, https://gitter.im/pikvm-auto/community
+Project-URL: Funding, https://github.com/sponsors/kettleofketchup
+Requires-Python: >=3.10
+Requires-Dist: pikvm-lib>=0.5.0
+Requires-Dist: pydantic-settings>=2.13.1
+Requires-Dist: rapidfuzz>=3.0
+Description-Content-Type: text/markdown
+
+# pikvm-auto
+
+[![ci](https://github.com/kettleofketchup/pikvm-auto/workflows/ci/badge.svg)](https://github.com/kettleofketchup/pikvm-auto/actions?query=workflow%3Aci)
+[![documentation](https://img.shields.io/badge/docs-zensical-FF9100.svg?style=flat)](https://kettleofketchup.github.io/pikvm-auto/)
+[![pypi version](https://img.shields.io/pypi/v/pikvm-auto.svg)](https://pypi.org/project/pikvm-auto/)
+[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#pikvm-auto:gitter.im)
+
+pikvmautomation, library, and ansible modules
+
+## Installation
+
+```bash
+pip install pikvm-auto
+```
+
+With [`uv`](https://docs.astral.sh/uv/):
+
+```bash
+uv tool install pikvm-auto
+```

pikvm_auto-0.3.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+pikvm_auto-0.3.0.dist-info/METADATA,sha256=0g4SEswEnwP85kL_WwuPBvgxZhIN-2vctfYglhmumY0,2299
+pikvm_auto-0.3.0.dist-info/WHEEL,sha256=Z36eTX6lG3PITRleSd5hAZHCcz52yg3c0JQVxKBbLW0,90
+pikvm_auto-0.3.0.dist-info/entry_points.txt,sha256=BuScwF5RTJuJiCxhp04Dnc1XZv5FJRGEl1yr_Cdb1xE,77
+pikvm_auto-0.3.0.dist-info/licenses/LICENSE,sha256=TRD-XzqhdrBbIpokiGa61wuDTBc_ElKoFP9HSNihODc,10255
+pikvm_auto/__init__.py,sha256=Vg1eEwVNOYv6jbxlm4NQe_XcbV3R3TBZWarBlD7uE9A,747
+pikvm_auto/__main__.py,sha256=23pOM6rlCbkun7mcyocHQIs1Rd-VyBl8ygfJFID0qqY,355
+pikvm_auto/_internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pikvm_auto/_internal/cli.py,sha256=0EkSG-bt5LeYseHrJxWsHNlmuiwXEjXESWHIjcGosPQ,3166
+pikvm_auto/_internal/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pikvm_auto/_internal/commands/hid.py,sha256=P-x2QDMZkG1IJMjZ8zhhDGxKIWUun4PeSAioYNfEIU8,10077
+pikvm_auto/_internal/commands/info.py,sha256=_7UZrJVz9W7HgbHy8c3B8pmtpOifIeOajHvnO8MEIG8,642
+pikvm_auto/_internal/commands/screenshot.py,sha256=zccQc49o9KvXn7q6fRiDI4K3Q7tC19S26hn6VkIDIWI,6959
+pikvm_auto/_internal/config.py,sha256=uAjj_L739Z_g5NoY6LHWqZGocdppYKP57ybVqndXpwQ,2096
+pikvm_auto/_internal/debug.py,sha256=pqnDwBccezFGXAq2c_hQWtjX2FUv6b7mE26az_U1yK4,2818
+pikvm_auto/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pikvm_auto-0.3.0.dist-info/RECORD,,

pikvm_auto-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: pdm-backend (2.4.8)
+Root-Is-Purelib: true
+Tag: py3-none-any

pikvm_auto-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+pikvm-auto = pikvm_auto._internal.cli:main
+
+[gui_scripts]
+

pikvm_auto-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.