corvix.config.dashboards

Dashboard configuration model and YAML parsing.

Attributes

Classes

DashboardSpec

Dashboard configuration for sorting, grouping, and filtering.

Functions

default_dashboard(→ DashboardSpec)

Return the fallback dashboard used when config defines none.

no_filters_dashboard(→ DashboardSpec)

Return the hardcoded dashboard that bypasses config-driven filtering.

available_dashboards(→ list[DashboardSpec])

Return configured dashboards plus the built-in rule-free dashboard.

is_no_filters_dashboard(→ bool)

Return whether the dashboard is the hardcoded rule-free dashboard.

_parse_dashboards(→ list[DashboardSpec])

_parse_dashboard_ignore_rules(...)

Module Contents

corvix.config.dashboards.NO_FILTERS_DASHBOARD_NAME = 'no filters'[source][source]
class corvix.config.dashboards.DashboardSpec[source][source]

Dashboard configuration for sorting, grouping, and filtering.

name: str[source][source]
group_by: str = 'none'[source][source]
sort_by: str = 'score'[source][source]
descending: bool = True[source][source]
include_read: bool = False[source][source]
max_items: int = 100[source][source]
match: corvix.config.rules.MatchCriteria[source][source]
ignore_rules: list[corvix.config.rules.MatchCriteria] = [][source][source]
corvix.config.dashboards.default_dashboard() DashboardSpec[source][source]

Return the fallback dashboard used when config defines none.

corvix.config.dashboards.no_filters_dashboard() DashboardSpec[source][source]

Return the hardcoded dashboard that bypasses config-driven filtering.

corvix.config.dashboards.available_dashboards(dashboards: list[DashboardSpec]) list[DashboardSpec][source][source]

Return configured dashboards plus the built-in rule-free dashboard.

corvix.config.dashboards.is_no_filters_dashboard(dashboard: DashboardSpec) bool[source][source]

Return whether the dashboard is the hardcoded rule-free dashboard.

corvix.config.dashboards._parse_dashboards(value: object) list[DashboardSpec][source][source]
corvix.config.dashboards._parse_dashboard_ignore_rules(value: object) list[corvix.config.rules.MatchCriteria][source][source]