Pirec
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
- Issue Tracker: github.com/jstutters/pirec/issues
- Source Code: github.com/jstutters/pirec
Support
If you are having problems, please let me know by submitting an issue in the tracker.