⚡ API Reference

Python API documentation for developers

BaseAuditor Class

Abstract base class for all OS-specific auditors.

Methods

run_all_checks() → List[CheckResult]

Execute all compliance checks and return results.

get_compliance_score() → float

Calculate and return compliance percentage (0-100).

export_results(filepath: str)

Export audit results to JSON file.

CheckResult Class

Represents the result of a single CIS check.

Attributes

  • check_id - Check identifier (e.g., "1.1.1")
  • title - Check title
  • status - Result status (pass, fail, skip, error)
  • severity - Severity level (low, medium, high, critical)
  • remediation - Fix instructions

HTMLReporter Class

Generate HTML compliance reports.

Methods

generate(audit_data: Dict, output_path: str) → str

Generate HTML report from audit data and return file path.

← Back to Home