A Python workflow library.
Project description
plumpy
A python workflows library that supports writing Processes with a well defined set of inputs and outputs that can be strung together.
RabbitMQ is used to queue up, control and monitor running processes via the kiwipy library.
Features:
- Processes can be remotely controlled by sending messages over RabbitMQ all from a simple interface
- Progress can be saved between steps and continued later
- Optional explicit specification of inputs and outputs including their types, validation functions, help strings, etc.
Installation
pip install plumpy
or
conda install -c conda-forge plumpy
Development
This package utilises tox for unit test automation, and pre-commit for code style formatting and test automation.
To install these development dependencies:
pip install tox pre-commit
To run the unit tests:
tox
For the rmq tests you will require a running instance of RabbitMQ.
One way to achieve this is using Docker and launching test/rmq/docker-compose.yml.
To run the pre-commit tests:
pre-commit run --all
To build the documentation:
tox -e docs-clean
Changes should be submitted as Pull Requests (PRs) to the develop branch.
Publishing Releases
- Create a release PR/commit to the
developbranch, updatingplumpy/version.pyandCHANGELOG.md. - Fast-forward merge
developinto themasterbranch - Create a release on GitHub (https://github.com/aiidateam/plumpy/releases/new), pointing to the release commit on
master, namedv.X.Y.Z(identical to version inplumpy/version.py) - This will trigger the
continuous-deploymentGitHub workflow which, if all tests pass, will publish the package to PyPi. Check this has successfully completed in the GitHub Actions tab (https://github.com/aiidateam/plumpy/actions).
(if the release fails, delete the release and tag)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file plumpy-0.21.5.tar.gz.
File metadata
- Download URL: plumpy-0.21.5.tar.gz
- Upload date:
- Size: 72.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.28.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fd2993c06fd334f7f59effc96d21b590f7bafd6a589f427fdbab2cccf783eb7b |
|
| MD5 | 210ff68da302f20340cc264bf3d92774 |
|
| BLAKE2b-256 | aac0b0f3093b31f19a2cbc74f7b50a6d7328809a3bedc24d341158fca9e56fd3 |
Provenance
File details
Details for the file plumpy-0.21.5-py3-none-any.whl.
File metadata
- Download URL: plumpy-0.21.5-py3-none-any.whl
- Upload date:
- Size: 73.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.28.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 90cd7f16753fa093f0bbd8176a2490197ada62f61be7843955a5a131dd59d2ba |
|
| MD5 | 69ca2d120fb0bd6c143bd13db761a87b |
|
| BLAKE2b-256 | fe53c90e575bb1802c012ccb9b6f82381926d108b9318698dffcca3a7dc1111b |
