Package `pipestat` Documentation

Package Overview

The pipestat package standardizes reporting of pipeline results and pipeline status management. It provides a formal way for pipeline developers and downstream tools to communicate pipeline outputs and status.

Key Features

Results Reporting: Standardized API for reporting pipeline results
Status Management: Track pipeline execution status
Backend Flexibility: Store results in YAML files or databases
Schema Validation: Validate results against defined schemas
Multi-pipeline Support: Manage results from multiple pipelines

Installation

pip install pipestat

Quick Example

from pipestat import SamplePipestatManager

# Initialize with a schema and results file
psm = SamplePipestatManager(
    schema_path="output_schema.yaml",
    results_file_path="results.yaml"
)

# Report a result
psm.report(record_identifier="sample1", values={"result_name": 42})

API Reference

SamplePipestatManager Class

The main class for managing sample-level pipeline results:

SamplePipestatManager

SamplePipestatManager(**kwargs)

Bases: PipestatManager

Convenience wrapper that creates a PipestatManager with pipeline_type="sample".

Equivalent to PipestatManager(pipeline_type="sample", **kwargs). All arguments are forwarded to PipestatManager.init.

Source code in pipestat/pipestat.py

def __init__(self, **kwargs) -> None:
    PipestatManager.__init__(self, pipeline_type="sample", **kwargs)

ProjectPipestatManager Class

ProjectPipestatManager

ProjectPipestatManager(**kwargs)

Bases: PipestatManager

Convenience wrapper that creates a PipestatManager with pipeline_type="project".

Equivalent to PipestatManager(pipeline_type="project", **kwargs). All arguments are forwarded to PipestatManager.init.