Basic functions

Pypiper is simple, but powerful. You really only need to know about 3 functions to get started. PipelineManager can do:

start_pipeline([args, multi]) Initialize setup.
run(cmd[, target, lock_name, shell, nofail, …]) The primary workhorse function of PipelineManager, this runs a command.
stop_pipeline([status]) Terminate the pipeline.

With those 3 functions, you can create a simple pipeline. Click on each function to view its in-depth documentation. There are quite a few optional parameters to the run function, which is where most of Pypiper’s power comes from.

When you’ve mastered the basics and are ready to get more powerful, add in a few new (optional) commands that make debugging and development easier:

timestamp([message, checkpoint, finished, …]) Print message, time, and time elapsed, perhaps creating checkpoint.
report_result(key, value[, annotation]) Writes a string to self.pipeline_stats_file.
clean_add(regex[, conditional, manual]) Add files (or regexs) to a cleanup list, to delete when this pipeline completes successfully.
get_stat(key) Returns a stat that was previously reported.

The complete documentation for these functions can be found in the API.