Helper classes to develop executable workflow scripts
Project description
Executable Workflow
Documentation: https://namuan.github.io/py-executable-checklist
Source Code: https://github.com/namuan/py-executable-checklist
PyPI: https://pypi.org/project/py-executable-checklist/
Helper classes to develop executable workflow scripts
Installation
pip install py-executable-checklist
Example Usage
import logging
from argparse import ArgumentParser, RawDescriptionHelpFormatter
from py_executable_checklist.workflow import run_workflow, WorkflowBase
# Common functions across steps
# Workflow steps
class DoSomething(WorkflowBase):
"""
Go to this page
Copy the command
Run the command
Copy the output and paste it into the email
"""
username: str
def execute(self):
logging.info(f"Hello {self.username}")
# output
return {"greetings": f"Hello {self.username}"}
# Workflow definition
def workflow():
return [
DoSomething,
]
# Boilerplate
def parse_args():
parser = ArgumentParser(
description=__doc__, formatter_class=RawDescriptionHelpFormatter
)
parser.add_argument("-u", "--username", type=str, required=True, help="User name")
parser.add_argument(
"-v",
"--verbose",
action="store_true",
default=False,
dest="verbose",
help="Display context variables at each step",
)
return parser.parse_args()
def main(args):
context = args.__dict__
run_workflow(context, workflow())
if __name__ == "__main__":
args = parse_args()
main(args)
Development
- Clone this repository
- Requirements:
- Poetry
- Python 3.7+
- Create a virtual environment and install the dependencies
poetry install
- Activate the virtual environment
poetry shell
Validating build
make build
Release process
A release is automatically published when a new version is bumped using make bump
. See .github/workflows/build.yml
for more details. Once the release is published, .github/workflows/publish.yml
will automatically publish it to PyPI.
Project details
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
Close
Hashes for py-executable-checklist-0.11.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60e71dfe3ce0eb73544927d609fee3449e7dab9ce6b05b076905dfb5e6b89f53 |
|
MD5 | 2d32c80d4204fb7d3f06b2e82683cb24 |
|
BLAKE2b-256 | 3292728b112d1e9e3739c88beeafeee83d7bb1ba34fbb02e220317aff3291fef |
Close
Hashes for py_executable_checklist-0.11.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1a10e79dae2a1ad6b11bcfab6b434ff1a3bcb29ecc3209758db954b8129fb7e |
|
MD5 | 51dc337438db935bb0f42a625b675ccf |
|
BLAKE2b-256 | db09fa17ac59f5c078bb4e5b2f98eddcf20a749531d4f94c2e9ea5a36e084eb1 |