coco_pipe.report.config

Pydantic schemas for report configuration and provenance metadata.

Classes

ProvenanceConfig	Runtime provenance attached to generated reports.
ReportConfig	User-facing configuration attached to a report.

Module Contents

class coco_pipe.report.config.ProvenanceConfig(/, **data)

Bases: pydantic.BaseModel

Runtime provenance attached to generated reports.

Parameters:

data (Any)

source: str = None

git_hash: str = None

timestamp_utc: str = None

command: str | None = None

python_version: str | None = None

os_platform: str | None = None

coco_pipe_version: str = None

versions: dict[str, str] = None

classmethod from_env(source='Unknown', **kwargs)

Build a ProvenanceConfig by capturing the current runtime environment.

Parameters:

• source (str) – Description of the data source.

• **kwargs (Any) – Additional metadata to override or append to the environment info.

Returns:

A new instance populated with runtime metrics.

Return type:

ProvenanceConfig

class coco_pipe.report.config.ReportConfig(/, **data)

Bases: pydantic.BaseModel

User-facing configuration attached to a report.

Parameters:

data (Any)

title: str = None

author: str | None = None

description: str | None = None

provenance: ProvenanceConfig = None

run_params: dict[str, Any] = None