pdstools.adm.HealthCheckMarkdown¶

Classes¶

Render health-check findings as GitHub-flavored Markdown.

class HealthCheckMarkdownRenderer(analysis: pdstools.adm.Analysis.Analysis)¶

Render health-check findings as GitHub-flavored Markdown.

render(*, title: str = 'ADM Health Check', subtitle: str = '', disclaimer: str = '', active_filter: polars.Expr | None = None, active_threshold_days: int = 30, prediction=None, preaggregates: pdstools.adm.Analysis.HealthCheckPreAggregates | None = None) → str¶

Render the health-check findings as a markdown document.

Parameters:

Return type:

str

key_metrics_table(last_data: polars.DataFrame, findings: list[pdstools.adm.Analysis.Finding], active_filter: polars.Expr | None, *, preaggregates: pdstools.adm.Analysis.HealthCheckPreAggregates | None = None) → polars.DataFrame¶

Build a compact key-metrics table for markdown output.

Parameters:

Return type:

polars.DataFrame

estate_snapshot_sections(active_filter: polars.Expr | None, *, preaggregates: pdstools.adm.Analysis.HealthCheckPreAggregates | None = None) → list[tuple[str, polars.DataFrame]]¶

Build compact orientation tables for the markdown report.

Parameters:

Return type:

list[tuple[str, polars.DataFrame]]

static findings_by_severity_table(findings: list[pdstools.adm.Analysis.Finding]) → polars.DataFrame¶

Summarize findings by severity.

static findings_by_category_table(findings: list[pdstools.adm.Analysis.Finding]) → polars.DataFrame¶

Summarize findings by category.