# pypyr automation task runner
All documentation is here: <https://pypyr.io/>
[](https://github.com/pypyr/pypyr/actions)
[](https://codecov.io/gh/pypyr/pypyr)
[](https://pypi.python.org/pypi/pypyr/)
[](https://opensource.org/licenses/Apache-2.0)
*pypyr*
> pronounce how you like, but I generally say *piper* as in "piping
down the valleys wild"
pypyr is a free & open-source task-runner that lets you define and run
sequential steps in a pipeline.
Like a turbo-charged shell script, but less finicky. Less annoying than
a makefile.
pypyr runs pipelines defined in yaml. A pipeline is pretty much anything
you want to automate with a sequence of steps.
Automate anything by combining commands, different scripts in different
languages & applications into one pipeline process.
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 & devops operations.
pypyr gives you simple variable substitution & configuration file
management so you can read, merge and write configuration files to and
from yaml, json or just text.
## Installation
```console
$ pip install --upgrade pypyr
```
Tested against Python \>=3.7
pypyr runs on Linux, MacOS & Windows. pypyr also runs fine on CI servers &
containers - pretty much anywhere with a Python run-time will work.
## Usage
### This is a pipeline
Example pipeline that runs a sequence of steps and takes an optional
custom cli input argument:
```yaml
# ./show-me-what-you-got.yaml
context_parser: pypyr.parser.keyvaluepairs
steps:
- name: pypyr.steps.echo
in:
echoMe: o hai!
- name: pypyr.steps.cmd
in:
cmd: echo any cmd you like
- name: pypyr.steps.shell
in:
cmd: echo ninja shell power | grep '^ninja.*r$'
- name: pypyr.steps.py
in:
py: print('any python you like')
- name: pypyr.steps.cmd
while:
max: 3
in:
cmd: echo gimme a {whileCounter}
- name: pypyr.steps.cmd
foreach: [once, twice, thrice]
in:
cmd: echo say {i}
- name: pypyr.steps.default
in:
defaults:
sayBye: False
- name: pypyr.steps.echo
run: '{sayBye}'
in:
echoMe: k bye!
```
### This is how you run a pipeline
This is what happens when you run this pipeline:
```console
$ pypyr show-me-what-you-got
o hai!
any cmd you like
ninja shell power
any python you like
gimme a 1
gimme a 2
gimme a 3
say once
say twice
say thrice
$ pypyr show-me-what-you-got sayBye=true
o hai!
any cmd you like
ninja shell power
any python you like
gimme a 1
gimme a 2
gimme a 3
say once
say twice
say thrice
k bye!
```
## Help!
Don't Panic! Check the [pypyr technical docs](https://pypyr.io/docs/)
to begin. For help, community & talk, check [pypyr
twitter](https://twitter.com/pypyrpipes/), or join the chat at the
[pypyr community discussion forum](https://github.com/pypyr/pypyr/discussions)!
## Contribute
### Developers
For information on how to help with pypyr, run tests and coverage,
please do check out the [contribution guide](CONTRIBUTING.md).
### Bugs
Well, you know. No one's perfect. Feel free to [create an
issue](https://github.com/pypyr/pypyr/issues/new).
## License
pypyr is free & open-source software distributed under the Apache 2.0 License.
Please see [LICENSE file](LICENSE) in the root of the repo..
Copyright 2017 the pypyr contributors.
Raw data
{
"_id": null,
"home_page": null,
"name": "pypyr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "task-runner,automation,devops,ci/cd,pipeline runner",
"author": null,
"author_email": "Thomas Gaigher <info@pypyr.io>",
"download_url": "https://files.pythonhosted.org/packages/34/c3/f15d53d546d7ee74ec13643c1a98f5690504f91f6febc3aae4524367179f/pypyr-5.9.1.tar.gz",
"platform": null,
"description": "\n\n# pypyr automation task runner\nAll documentation is here: <https://pypyr.io/>\n\n[](https://github.com/pypyr/pypyr/actions)\n[](https://codecov.io/gh/pypyr/pypyr)\n[](https://pypi.python.org/pypi/pypyr/)\n[](https://opensource.org/licenses/Apache-2.0)\n\n*pypyr*\n\n> pronounce how you like, but I generally say *piper* as in \"piping\n down the valleys wild\"\n\npypyr is a free & open-source task-runner that lets you define and run\nsequential steps in a pipeline.\n\nLike a turbo-charged shell script, but less finicky. Less annoying than\na makefile.\n\npypyr runs pipelines defined in yaml. A pipeline is pretty much anything\nyou want to automate with a sequence of steps.\n\nAutomate anything by combining commands, different scripts in different\nlanguages & applications into one pipeline process.\n\nYou can run loops, conditionally execute steps based on conditions you\nspecify, wait for status changes before continuing, break on failure\nconditions or swallow errors. Pretty useful for orchestrating continuous\nintegration, continuous deployment & devops operations.\n\npypyr gives you simple variable substitution & configuration file\nmanagement so you can read, merge and write configuration files to and\nfrom yaml, json or just text.\n\n## Installation\n\n```console\n$ pip install --upgrade pypyr\n```\n\nTested against Python \\>=3.7\n\npypyr runs on Linux, MacOS & Windows. pypyr also runs fine on CI servers &\ncontainers - pretty much anywhere with a Python run-time will work.\n\n## Usage\n### This is a pipeline\nExample pipeline that runs a sequence of steps and takes an optional\ncustom cli input argument:\n\n```yaml\n# ./show-me-what-you-got.yaml\ncontext_parser: pypyr.parser.keyvaluepairs\nsteps:\n - name: pypyr.steps.echo\n in:\n echoMe: o hai!\n - name: pypyr.steps.cmd\n in:\n cmd: echo any cmd you like\n - name: pypyr.steps.shell\n in:\n cmd: echo ninja shell power | grep '^ninja.*r$' \n - name: pypyr.steps.py\n in:\n py: print('any python you like')\n - name: pypyr.steps.cmd\n while:\n max: 3\n in:\n cmd: echo gimme a {whileCounter}\n - name: pypyr.steps.cmd\n foreach: [once, twice, thrice]\n in:\n cmd: echo say {i}\n - name: pypyr.steps.default\n in:\n defaults:\n sayBye: False\n - name: pypyr.steps.echo\n run: '{sayBye}'\n in:\n echoMe: k bye!\n```\n\n### This is how you run a pipeline\nThis is what happens when you run this pipeline:\n\n```console\n$ pypyr show-me-what-you-got\no hai!\nany cmd you like\nninja shell power\nany python you like\ngimme a 1\ngimme a 2\ngimme a 3\nsay once\nsay twice\nsay thrice\n\n$ pypyr show-me-what-you-got sayBye=true \no hai!\nany cmd you like\nninja shell power\nany python you like\ngimme a 1\ngimme a 2\ngimme a 3\nsay once\nsay twice\nsay thrice\nk bye!\n```\n\n## Help!\nDon't Panic! Check the [pypyr technical docs](https://pypyr.io/docs/)\nto begin. For help, community & talk, check [pypyr\ntwitter](https://twitter.com/pypyrpipes/), or join the chat at the \n[pypyr community discussion forum](https://github.com/pypyr/pypyr/discussions)!\n\n## Contribute\n### Developers\nFor information on how to help with pypyr, run tests and coverage,\nplease do check out the [contribution guide](CONTRIBUTING.md).\n\n### Bugs\nWell, you know. No one's perfect. Feel free to [create an\nissue](https://github.com/pypyr/pypyr/issues/new).\n\n## License\npypyr is free & open-source software distributed under the Apache 2.0 License.\n\nPlease see [LICENSE file](LICENSE) in the root of the repo..\n\nCopyright 2017 the pypyr contributors.\n",
"bugtrack_url": null,
"license": null,
"summary": "task-runner for automation pipelines defined in yaml. cli & api.",
"version": "5.9.1",
"project_urls": {
"Documentation": "https://pypyr.io/docs/",
"Home": "https://pypyr.io",
"Release Notes": "https://pypyr.io/updates/releases/",
"Source": "https://github.com/pypyr/pypyr/",
"Tracker": "https://github.com/pypyr/pypyr/issues",
"Twitter": "https://twitter.com/pypyrpipes"
},
"split_keywords": [
"task-runner",
"automation",
"devops",
"ci/cd",
"pipeline runner"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8002a23f3c205b09be057ab6000ffdd5dbba30ec958603e785361e7e722788ba",
"md5": "5e670af0201bcd4d1de32cd9926d7ab5",
"sha256": "2103d9ed83d5c8f455bbe2443f9fbd829196435ffe30143b58a0a03800e3d95d"
},
"downloads": -1,
"filename": "pypyr-5.9.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e670af0201bcd4d1de32cd9926d7ab5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 170760,
"upload_time": "2023-09-22T03:14:38",
"upload_time_iso_8601": "2023-09-22T03:14:38.824095Z",
"url": "https://files.pythonhosted.org/packages/80/02/a23f3c205b09be057ab6000ffdd5dbba30ec958603e785361e7e722788ba/pypyr-5.9.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "34c3f15d53d546d7ee74ec13643c1a98f5690504f91f6febc3aae4524367179f",
"md5": "524048e2048e63c4f5a8899b1c90cbd8",
"sha256": "a87f8410acf41eb24e45ec57107269a043e6afff4170c7cef21b95497f0614ac"
},
"downloads": -1,
"filename": "pypyr-5.9.1.tar.gz",
"has_sig": false,
"md5_digest": "524048e2048e63c4f5a8899b1c90cbd8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 276783,
"upload_time": "2023-09-22T03:14:40",
"upload_time_iso_8601": "2023-09-22T03:14:40.524414Z",
"url": "https://files.pythonhosted.org/packages/34/c3/f15d53d546d7ee74ec13643c1a98f5690504f91f6febc3aae4524367179f/pypyr-5.9.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-22 03:14:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pypyr",
"github_project": "pypyr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pypyr"
}
JSON
