oct.health package

Health check module for OCT.

Purpose

Provides a single-command project compliance dashboard.

Responsibilities

• Export the main health check entry point (run_health).

• Enable CLI integration of the health command.

Diagnostics

Domain: OCT.HEALTH Levels:

L2 — health check lifecycle L3 — individual check execution L4 — detailed per-file analysis

Contracts

• All public exports are guaranteed to be importable from this module.

oct.health.run_health(project_root: Path, json_mode: bool = False, verbose: bool = False, test_timeout: int | None = None, log_output: bool = False) → None

Run the project health dashboard.

Parameters:

• project_root (Path) – The detected Option C project root directory.

• json_mode (bool) – Output machine-readable JSON instead of terminal report.

• verbose (bool) – Show per-file details in addition to summary.

• test_timeout (int | None) – Maximum seconds to wait for pytest. Overrides health.test_timeout in .octrc.json. Defaults to 300 when neither is set (OI-413).

Submodules

• oct.health.oct_health module
  • Purpose
  • Responsibilities
  • Diagnostics
  • Contracts
  • Dependencies
  • check_compat_health()
  • check_docs_health()
  • check_fixable_health()
  • check_git_health()
  • check_lint_health()
  • check_test_health()
  • check_venv_health()
  • run_health()