GitXplorerGitXplorer
J

litestar-workflows

public
3 stars
0 forks
0 issues

Commits

List of commits on branch main.
Verified
01741e254413d1dc72bf3ddbcd6466d2483ca386

feat: initial internal api

JJacobCoffee committed 10 months ago
Verified
7a35c0595a1ae4b072264d99056d46cd516a3c54

chore: update project

JJacobCoffee committed 10 months ago
Verified
2b0aae8d11b7042cb2017f9464cfa83b850c5845

chore: fix badges

JJacobCoffee committed 10 months ago
Verified
d3c942d24fce9e7c6e9fa3364982828f548c0456

chore(release): add metadata

JJacobCoffee committed 10 months ago
Verified
ae0d890ffccb331a55cb359ccfd271206d27188a

ci(release): add release note config

JJacobCoffee committed 10 months ago
Verified
9e63e82c58f61a68eb357fe538a7a77579b1347e

build(deps): bump actions/setup-python from 4 to 5 (#4)

ddependabot[bot] committed 10 months ago

README

The README file for this repository.

litestar-workflows

Latest Release Tests And Linting

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.
  • Literally anything with some arbitrary series of steps.

...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.