Skip to main content

Workflow management in Litestar

Project description

litestar-workflows

A simple library for creating and managing workflows in Litestar.

"Workflows" are a way to define a series of steps that need to be completed to achieve a goal. litestar-workflows provides a way to define workflows in code, and then execute them in a controlled manner.

Some examples of workflows that could be defined with litestar-workflows include:

  • A user creates a new post on a blog, and the post needs to be reviewed by an editor before it can be published.
  • A developer implements a new feature, and the feature must be reviewed by their team -> QA -> product owner -> ... before it can be reflected in the production environment.
  • Approval workflows for various business processes like expense reports, vacation requests, etc.
  • A user requests a new virtual machine, and the request must be approved by a manager before the VM is created.
  • I need to run a command on a set of hosts, but I need approval from a manager -> directory -> VP -> ... before the command is executed.

...and many more!

Installation

python3 -m pip install litestar-workflows

Usage

Here's a simple example of how to define and execute a workflow using litestar-workflows:

from litestar_workflows import Workflow, Step

# TODO: Define the steps of the workflow :)

Versioning

This project uses Semantic Versioning.

  • Major versions introduce breaking changes.
  • Major versions will support the currently supported version(s) of Litestar.

Contributing

Contributions are welcome! For more information, please see CONTRIBUTING.rst.

License

This project is licensed under the terms of the MIT license. For more information, please see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

litestar_workflows-0.1.0.tar.gz (4.5 kB view hashes)

Uploaded Source

Built Distribution

litestar_workflows-0.1.0-py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page