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 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 run(self, context):
logging.info(f"Hello {self.username}")
# output
context["greetings"] = f"Hello {context['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
Development and Release process
A release is automatically published when a new version is bumped using make bump
.
See .github/workflows/test_release.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.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3567b73c94a043ff4caed1d18870915735753b65697b159a23c6ddf06d756350 |
|
MD5 | a722448b86e0a97b8e7acc343ed6c75c |
|
BLAKE2b-256 | 1b6432f850dcb5b447268061e490578642d6aafd685691867047f86ad278da85 |
Close
Hashes for py_executable_checklist-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19d3a25972c67d207fd1417145bd7dbf693a620877217547eec5b291b92ba964 |
|
MD5 | 487d44be65807397155ab9fa621ad8fb |
|
BLAKE2b-256 | d0893d81e4ec84a2a0164f808b88aca38a1a321daba3d496e3e652bc2b53c1cc |