pypyr technical documentation

Here you will find technical documentation for using the pypyr task-runner. The documentation covers how to sequence your tasks in a pipeline in yaml format and how to run your pipeline tasks from the CLI or the Python API.

pypyr is a task-runner cli & api

pypyr is a command line interface & api to run pipelines defined in yaml. Think of pypyr as a simple task runner that lets you define and run sequential steps.

Like a turbo-charged shell script, but less finicky.

pypyr

pronounce how you like, but I generally say piper as in “piping down the valleys wild”

You can run loops, conditionally execute steps based on conditions you specify, wait for status changes before continuing, break on failure conditions or swallow errors. Pretty useful for orchestrating continuous integration, continuous deployment and devops operations.

Read, merge and write configuration files to and from yaml, json or just plain old text.

pypyr runs on Linux, MacOS & Windows - anywhere with a Python runtime, really.

examples

You can find full runnable sample pipelines in the pypyr examples repo.

documentation sections

• getting started

  Quick start to help if you’re new to the pypyr task-runner.

• api

  Easily extend pypyr with the simple Python API. Create your own steps and context argument parsers. Call pypyr programmatically from your own code.

• cli

  Run yaml pipelines from the simple pypyr command line interface (CLI). Pipelines are in simple human-readable yaml for agentless automation.

• context parsers

  pypyr context parsers initialize the context from your own custom cli input arguments.

• contributing

  pypyr is open-source. You don’t have to write code to contribute, you can help with reporting bugs, documentation, examples and ideas. This guide will help you contribute to open-source software.

• decorators

  Selectively run, skip, repeat, loop & handle errors on individual steps.

• loaders

  Loaders discover and load your pipelines.

• pipelines

  Pipelines are sequences of steps that you define in a simple yaml file.

• plugins

  A listing of pypyr’s official plug-ins. Add AWS & Slack functions to your pipelines.

• steps

  A listing of pypyr built-in ready-made steps. Scroll through all pypyr’s built-in steps here.

• substitutions

  Use string formatting expressions to make substitutions or token replacements in context strings, fields or config.

• thank you

  pypyr acknowledgements, dependencies & thank yous