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.11.0.tar.gz (88.7 kB view details)

Uploaded Source

Built Distribution

pipestat-0.11.0-py3-none-any.whl (87.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pipestat-0.11.0.tar.gz
  • Upload date:
  • Size: 88.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pipestat-0.11.0.tar.gz
Algorithm Hash digest
SHA256 df733f343713330cce4a3b430746b0760ff384153db0ec46d84f02d59182f8e2
MD5 26f963956bcf6874a1e7871f3f4eeadf
BLAKE2b-256 37094c1ef734aa6201d8d828654b825378a7b17b444cc36aecac6bf51662f03e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pipestat-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 87.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pipestat-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c8478b0bdc078e1eba45097844317b4ce1a0b2c38ba2d45fe2a95c0cd31c4f21
MD5 bc0015f5b9d534accbeb8babd23e1d13
BLAKE2b-256 6b11594335cce104cc2dce0010813393546c3b09b9d2473b1681ad2c2f886eb4

See more details on using hashes here.

Supported by

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