[DustinTrap]

Closes #260.

What

docs/python-library.md — the reference page the audit found missing: docs/ covered CLI, configuration and the MCP server, but a library user had only README snippets and the agent-facing skill playbook (which is about driving safely, not about what exists).

Sections: the public import surface (kvm_pilot.__all__ + subpackages, underscore = private) · building a driver (make_driver, resolve_host precedence, make_driver_from_config incl. auto, register_driver) with a table of every kind and its constructor · capabilities and the protocol → method table, VideoScope semantics · the KVMClient method surface grouped, destructive ones marked · safety (dry_run first, then confirm; allow_all default means unattended; EffectClass/effect_of) · health (run_healthcheck, HealthReport, preflight/HealthGateError, AutoFix) · the full error hierarchy with when-raised · vision (make_backend kinds, VisionBackend contract, ScreenAnalyzer options, ALL_PHASES, the sensing hierarchy and DEFAULT_OCR_RULES, consensus) · the two SSH channels · the auto-detection probe table from detect.py · evidence-data helpers (load_registry, rollup, compute_maturity) · a complete safe script.

This closes the "sensing-hierarchy prose home" half of #13 and the library half of #152's best-practices ask, as the issue anticipated.

Why python-library.md, not library.md

The skill playbook src/kvm_pilot/skill/references/library.md already publishes to the wiki as library.md, and wiki link rewriting maps by file stem, so a second library.md would collide. The reason is recorded next to the PAGES entry.

Verification

• Every snippet and every claimed signature/behaviour was executed against the fake driver before writing (deny_all → SafetyError; dry_run flip skips; effect_of; run_healthcheck(...).worst; KeyError on an unknown profile; ValueError on an unknown kind; wait_for_state raises kvm_pilot.TimeoutError; the powered fake with phase="grub_menu" resolves without a model call; rollup(vendor="gl.inet", product="RM1PE") returns rows).
• Registered in PAGES (Reference), docs/README.md, llms.txt; build_wiki.py --check and the docs guards pass.

🤖 Generated with Claude Code

[coderabbitai]

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Team
• Run ID: 48606bb2-97da-4275-9727-66128c87b2d2

📥 Commits

Reviewing files that changed from the base of the PR and between 9a1c975 and 4491962.

📒 Files selected for processing: 5

• .github/scripts/build_wiki.py
• CHANGELOG.md
• docs/README.md
• docs/python-library.md
• llms.txt

+----------------------------------------------------------------------------------------------------------------------+
| You can't write perfect software. Software can't be perfect. Protect your code and users from the inevitable errors. |
+----------------------------------------------------------------------------------------------------------------------+
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

✨ Finishing Touches

📝 Generate docstrings

• Commit to this branch
• Create a new PR

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

_{Comment @coderabbitai help to get the list of available commands.}