corvix.config

YAML configuration for Corvix dashboards and polling.

Attributes

_POLLING_PER_PAGE_MIN
_POLLING_PER_PAGE_MAX
_CONTEXT_OPERATORS
DEFAULT_CONFIG

Classes

ContextPredicate	Predicate evaluated against enriched notification context.
MatchCriteria	Filter fields for rules and dashboards.
RuleAction	Action emitted when a rule matches.
Rule	Global or repository-scoped automation rule.
RuleSet	Collection of global and per-repository rules.
DashboardSpec	Dashboard configuration for sorting, grouping, and filtering.
ScoringConfig	Configurable scoring model for notifications.
PollingConfig	Polling behavior for ingestion.
GitHubConfig	GitHub API configuration.
GitHubAccountConfig	One GitHub account configuration for multi-account polling.
GitHubLatestCommentEnrichmentConfig	Config for enriching comment notifications with latest-comment metadata.
GitHubPRStateEnrichmentConfig	Config for enriching pull-request notifications with PR state.
EnrichmentConfig	Top-level enrichment configuration.
StateConfig	State/cache location for persisted notifications.
BrowserTabTargetConfig	Config for in-tab browser notification delivery.
WebPushTargetConfig	Config for background Web Push notification delivery (phase 2).
NotificationsDetectConfig	Controls which records qualify for notification events.
NotificationsConfig	Top-level notifications configuration.
AuthConfig	Authentication mode configuration.
DatabaseConfig	PostgreSQL connection configuration.
AppConfig	Top-level application config.

Functions

_ensure_map(→ dict[str, object])
_ensure_list(→ list[object])
_as_bool(→ bool)
_as_int(→ int)
_as_float(→ float)
_as_str(→ str)
_get_str(→ str)
_get_optional_str(→ str | None)
_get_bool(→ bool)
_get_optional_bool(→ bool | None)
_get_int(→ int)
_get_float(→ float)
_get_optional_float(→ float | None)
_to_str_list(→ list[str])
_parse_match(→ MatchCriteria)
_parse_context_predicates(→ list[ContextPredicate])
_parse_context_predicate(→ ContextPredicate)
_parse_rules(→ RuleSet)
_parse_rule(→ Rule)
_parse_dashboards(→ list[DashboardSpec])
_parse_dashboard_ignore_rules(→ list[MatchCriteria])
_parse_scoring(→ ScoringConfig)
_to_float_map(→ dict[str, float])
_parse_github(→ GitHubConfig)
_parse_polling(→ PollingConfig)
_parse_enrichment(→ EnrichmentConfig)
_parse_state(→ StateConfig)
_parse_auth(→ AuthConfig)
_parse_database(→ DatabaseConfig)
_parse_notifications(→ NotificationsConfig)
load_config(→ AppConfig)	Load and validate YAML config from disk.
write_default_config(→ None)	Write a starter configuration file.

Module Contents

corvix.config._POLLING_PER_PAGE_MIN = 1

corvix.config._POLLING_PER_PAGE_MAX = 50

corvix.config._CONTEXT_OPERATORS

class corvix.config.ContextPredicate

Predicate evaluated against enriched notification context.

path: str

op: str

value: object | None = None

case_insensitive: bool = False

class corvix.config.MatchCriteria

Filter fields for rules and dashboards.

repository_in: list[str] = []

repository_glob: list[str] = []

reason_in: list[str] = []

subject_type_in: list[str] = []

title_contains_any: list[str] = []

title_regex: str | None = None

unread: bool | None = None

min_score: float | None = None

max_age_hours: float | None = None

context: list[ContextPredicate] = []

class corvix.config.RuleAction

Action emitted when a rule matches.

action_type: str

class corvix.config.Rule

Global or repository-scoped automation rule.

name: str

match: MatchCriteria

actions: list[RuleAction] = []

exclude_from_dashboards: bool = False

class corvix.config.RuleSet

Collection of global and per-repository rules.

global_rules: list[Rule] = []

per_repository: dict[str, list[Rule]]

class corvix.config.DashboardSpec

Dashboard configuration for sorting, grouping, and filtering.

name: str

group_by: str = 'none'

sort_by: str = 'score'

descending: bool = True

include_read: bool = False

max_items: int = 100

match: MatchCriteria

ignore_rules: list[MatchCriteria] = []

class corvix.config.ScoringConfig

Configurable scoring model for notifications.

unread_bonus: float = 15.0

age_decay_per_hour: float = 0.25

reason_weights: dict[str, float]

repository_weights: dict[str, float]

subject_type_weights: dict[str, float]

title_keyword_weights: dict[str, float]

class corvix.config.PollingConfig

Polling behavior for ingestion.

interval_seconds: int = 60

per_page: int = 50

max_pages: int = 5

all: bool = False

participating: bool = False

class corvix.config.GitHubConfig

GitHub API configuration.

accounts: list[GitHubAccountConfig] = []

property token_env: str

Backward-compatible shortcut to first account token env.

property api_base_url: str

Backward-compatible shortcut to first account API base URL.

class corvix.config.GitHubAccountConfig

One GitHub account configuration for multi-account polling.

id: str

label: str

token_env: str

api_base_url: str = 'https://api.github.com'

class corvix.config.GitHubLatestCommentEnrichmentConfig

Config for enriching comment notifications with latest-comment metadata.

enabled: bool = False

timeout_seconds: float = 10.0

class corvix.config.GitHubPRStateEnrichmentConfig

Config for enriching pull-request notifications with PR state.

enabled: bool = False

timeout_seconds: float = 10.0

class corvix.config.EnrichmentConfig

Top-level enrichment configuration.

enabled: bool = False

max_requests_per_cycle: int = 25

github_latest_comment: GitHubLatestCommentEnrichmentConfig

github_pr_state: GitHubPRStateEnrichmentConfig

class corvix.config.StateConfig

State/cache location for persisted notifications.

cache_file: pathlib.Path

class corvix.config.BrowserTabTargetConfig

Config for in-tab browser notification delivery.

enabled: bool = True

max_per_cycle: int = 5

cooldown_seconds: int = 10

class corvix.config.WebPushTargetConfig

Config for background Web Push notification delivery (phase 2).

enabled: bool = False

vapid_public_key_env: str = 'CORVIX_VAPID_PUBLIC_KEY'

vapid_private_key_env: str = 'CORVIX_VAPID_PRIVATE_KEY'

subject: str = ''

class corvix.config.NotificationsDetectConfig

Controls which records qualify for notification events.

include_read: bool = False

min_score: float = 0.0

class corvix.config.NotificationsConfig

Top-level notifications configuration.

enabled: bool = True

detect: NotificationsDetectConfig

browser_tab: BrowserTabTargetConfig

web_push: WebPushTargetConfig

class corvix.config.AuthConfig

Authentication mode configuration.

mode: str = 'single_user'

session_secret: str = ''

class corvix.config.DatabaseConfig

PostgreSQL connection configuration.

url_env: str = 'DATABASE_URL'

class corvix.config.AppConfig

Top-level application config.

github: GitHubConfig

enrichment: EnrichmentConfig

polling: PollingConfig

state: StateConfig

scoring: ScoringConfig

rules: RuleSet

dashboards: list[DashboardSpec] = []

auth: AuthConfig

database: DatabaseConfig

notifications: NotificationsConfig

resolve_cache_file() → pathlib.Path

Resolve the configured cache path.

corvix.config.DEFAULT_CONFIG = Multiline-String

Show Value

"""github:
  accounts:
    - id: primary
      label: Primary
      token_env: GITHUB_TOKEN
      api_base_url: https://api.github.com

enrichment:
  enabled: false
  max_requests_per_cycle: 25
  github_latest_comment:
    enabled: false
    timeout_seconds: 10
  github_pr_state:
    enabled: false
    timeout_seconds: 10

polling:
  interval_seconds: 60
  per_page: 50
  max_pages: 5
  all: false
  participating: false

state:
  cache_file: ~/.cache/corvix/notifications.json

scoring:
  unread_bonus: 15
  age_decay_per_hour: 0.25
  reason_weights:
    mention: 50
    review_requested: 40
    assign: 30
    author: 10
  repository_weights:
    your-org/critical-repo: 25
  subject_type_weights:
    PullRequest: 10
  title_keyword_weights:
    security: 20
    urgent: 15

rules:
  global:
    - name: mute-bot-noise
      match:
        title_regex: ".*\[bot\].*"
      actions:
        - type: mark_read
      exclude_from_dashboards: true
  per_repository:
    your-org/infra:
      - name: mute-chore-prs
        match:
          title_contains_any: ["chore", "deps"]
        actions:
          - type: mark_read
        exclude_from_dashboards: true

dashboards:
  - name: overview
    group_by: reason
    sort_by: updated_at
    descending: true
    include_read: true
    max_items: 200
  - name: triage
    group_by: repository
    sort_by: score
    descending: true
    include_read: false
    max_items: 100
    match:
      reason_in: ["mention", "review_requested", "assign"]
    ignore_rules:
      - reason_in: ["comment"]
        context:
          - path: github.latest_comment.is_ci_only
            op: equals
            value: true
"""

corvix.config._ensure_map(value: object, section: str) → dict[str, object]

corvix.config._ensure_list(value: object, section: str) → list[object]

corvix.config._as_bool(value: object, field: str) → bool

corvix.config._as_int(value: object, field: str) → int

corvix.config._as_float(value: object, field: str) → float

corvix.config._as_str(value: object, field: str) → str

corvix.config._get_str(config: dict[str, object], key: str, default: str, field: str) → str

corvix.config._get_optional_str(config: dict[str, object], key: str, field: str) → str | None

corvix.config._get_bool(config: dict[str, object], key: str, default: bool, field: str) → bool

corvix.config._get_optional_bool(config: dict[str, object], key: str, field: str) → bool | None

corvix.config._get_int(config: dict[str, object], key: str, default: int, field: str) → int

corvix.config._get_float(config: dict[str, object], key: str, default: float, field: str) → float

corvix.config._get_optional_float(config: dict[str, object], key: str, field: str) → float | None

corvix.config._to_str_list(value: object) → list[str]

corvix.config._parse_match(value: object, *, section: str = 'match') → MatchCriteria

corvix.config._parse_context_predicates(value: object, *, section: str = 'match.context') → list[ContextPredicate]

corvix.config._parse_context_predicate(value: object, *, section: str = 'match.context[]') → ContextPredicate

corvix.config._parse_rules(value: object) → RuleSet

corvix.config._parse_rule(value: object) → Rule

corvix.config._parse_dashboards(value: object) → list[DashboardSpec]

corvix.config._parse_dashboard_ignore_rules(value: object) → list[MatchCriteria]

corvix.config._parse_scoring(value: object) → ScoringConfig

corvix.config._to_float_map(value: object, section: str) → dict[str, float]

corvix.config._parse_github(value: object) → GitHubConfig

corvix.config._parse_polling(value: object) → PollingConfig

corvix.config._parse_enrichment(value: object) → EnrichmentConfig

corvix.config._parse_state(value: object) → StateConfig

corvix.config._parse_auth(value: object) → AuthConfig

corvix.config._parse_database(value: object) → DatabaseConfig

corvix.config._parse_notifications(value: object) → NotificationsConfig

corvix.config.load_config(path: pathlib.Path) → AppConfig

Load and validate YAML config from disk.

corvix.config.write_default_config(path: pathlib.Path) → None

Write a starter configuration file.