Skip to main content

Records the inputs and outputs of scripts

Project description

Build Status Documentation Status

Pirec is a Python package for wrapping scripts so that their inputs and outputs are preserved in a consistent way and results are recorded.

Example

from pirec import call, record, pipeline
from pirec.artefacts import TextFile


@record()
def pipeline_stage_1(f):
    call(['/bin/cat', f.filename])


@record()
def pipeline_stage_2(f):
    call(['/bin/cat', f.filename])


def my_pipeline(file1, file2):
    pipeline_stage_1(file1)
    pipeline_stage_2(file2)


def example_pipeline():
    pipeline.run(
        'example',
        my_pipeline,
        '/my/data/directory',
        TextFile('month00/data.txt'), TextFile('month12/data.txt')
    )


if __name__ == '__main__':
    example_pipeline()

Installation

pip install pirec

Requirements

Pirec is tested with Python v2.7 - 3.6. Use of the MongoDB or SQLDatabase result recorders requires the installation of the pymongo or sqlalchemy modules as appropriate. Depending on your database SQLAlchemy may require additional support libraries to be installed.

Documentation

Full documentation is hosted on Read the Docs.

Contribute

Support

If you are having problems, please let me know by submitting an issue in the tracker.

Project details


Download files

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

Files for pirec, version 0.11.0
Filename, size File type Python version Upload date Hashes
Filename, size pirec-0.11.0.linux-x86_64.tar.gz (18.8 kB) File type Source Python version None Upload date Hashes View
Filename, size pirec-0.11.0-py2.py3-none-any.whl (14.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page