Skip to main content

A pipeline results reporter

Project description

PEP compatible Run pytests pypi-badge Code style: black

pipestat

Pipestat standardizes reporting of pipeline results. It provides 1) a standard specification for how pipeline outputs should be stored; and 2) an implementation to easily write results to that format from within Python or from the command line. A pipeline author defines all the outputs produced by a pipeline by writing a JSON-schema. The pipeline then uses pipestat to report pipeline outputs as the pipeline runs, either via the Python API or command line interface. The user configures results to be stored either in a YAML-formatted file or a PostgreSQL database.

See Pipestat documentation for complete details.

Developer tests

Optional Dependencies

Note: to run the pytest suite locally, you will need to install the related requirements:

cd pipestat

pip install -r requirements/requirements-test.txt

Database Backend Configuration for Tests

Many of the tests require a postgres database to be set up otherwise many of the tests will skip.

We recommend using docker:

docker run --rm -it --name pipestat_test_db \
    -e POSTGRES_USER=postgres \
    -e POSTGRES_PASSWORD=pipestat-password \
    -e POSTGRES_DB=pipestat-test \
    -p 5432:5432 \
    postgres

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pipestat-0.12.2.tar.gz (89.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pipestat-0.12.2-py3-none-any.whl (88.0 kB view details)

Uploaded Python 3

File details

Details for the file pipestat-0.12.2.tar.gz.

File metadata

  • Download URL: pipestat-0.12.2.tar.gz
  • Upload date:
  • Size: 89.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pipestat-0.12.2.tar.gz
Algorithm Hash digest
SHA256 1b8fccb9dd12073460f058c219d0f8afd8b0251176cc5216610baccc3f479fbb
MD5 69e02d1ec3679eaf3d206f78482893d8
BLAKE2b-256 87b9bda18c48a3242a49905849185d43b472d7b569fde16bf7d88b9948043f19

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipestat-0.12.2.tar.gz:

Publisher: python-publish.yml on pepkit/pipestat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pipestat-0.12.2-py3-none-any.whl.

File metadata

  • Download URL: pipestat-0.12.2-py3-none-any.whl
  • Upload date:
  • Size: 88.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pipestat-0.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6084a990d6729b58f268a0547c1ea33c291ccd9d3009b79cd28a09a0be58759c
MD5 850b937934a2753f4db6075bff9d85d7
BLAKE2b-256 628f548eb35894231eeba1d7e5ce4f0689de49e7ed81d3337bed738c649048d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipestat-0.12.2-py3-none-any.whl:

Publisher: python-publish.yml on pepkit/pipestat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page