No project description provided
Project description
Django Workflow Engine
django-workflow-engine
is a lightweight and reusable workflow engine for
Django applications. It enables you to better organise the business logic for
collaborating users.
Installation
pip install django-workflow-engine
Getting started
Add the application to your Django settings INSTALLED_APPS
list:
INSTALLED_APPS = [
...
"django_workflow_engine",
]
Add the built-in django-workflow-engine
view urls to your project's urls.py
as follows:
from django_workflow_engine import workflow_urls
...
urlpatterns = [
path("workflow/", workflow_urls()),
...
]
This will utilise all django-workflow-engine
built-in view classes. Default views are:
list_view=FlowListView
List of workflow instances view.view=FlowView
Workflow instance view.create_view=FlowCreateView
Create workflow view.continue_view=FlowContinueView
Workflow continuation view.diagram_view=FlowDiagramView
Workflow diagram view.
You can override any the built-in view classes with your own, for example to provide your own view classes for flow list and flow view:
urlpatterns = [
path("workflow/",
workflow_urls(
list_view=MyFlowListView,
view=MyFlowView,
),
),
]
Building your first workflow
Create a workflows.py
in your project and add your uniquely named workflows.
from django_workflow_engine import Step, Workflow
onboard_contractor = Workflow(
name="onboard_contractor",
steps=[
Step(...),
Step(...),
Step(...),
],
)
onboard_perm = Workflow(
name="onboard_perm",
steps=[
...
],
)
Add you workflows to your Django settings as follows:
DJANGO_WORKFLOWS = {
"onboard_contractor": "your_app.workflows.onboard_contractor",
"onboard_perm": "your_app.workflows.onboard_perm",
}
Each entry needs to be a valid module path where the final component is the name of your workflow class.
Finally, run the django-workflow-engine
migrations:
$ ./manage.py migrate
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
Hashes for django_workflow_engine-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08f2724f598aac0e02ff16a52500370f3fdca7b8d35e4871ef74d6a0503f0cff |
|
MD5 | 27be9b5e34f29a049f546216c482397e |
|
BLAKE2b-256 | da04583dfa28eec31d99f9dbe16eef0c5f7005af08bfe990add655223a8c2058 |
Hashes for django_workflow_engine-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2cb8bdb1e747d92a3a0be047c2b122411aa9ee8f2c6ed00e048cf0fe3e709575 |
|
MD5 | 0397ba513059904c0776c7719717a9cd |
|
BLAKE2b-256 | d083184814941a74d562c568b51233afde47457d387aad054f1f4de64eb16b3a |