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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e0c4a562909c9582a69019c41936367729da2effb577379eb83f83912055d74 |
|
MD5 | a3a1df981e39d1522aecb91fdddbe08f |
|
BLAKE2b-256 | cec1397e2339a79dc734861dfc8a95451b99de1cb49b49b4dfd48038636f5b8a |
Hashes for django_workflow_engine-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8a039464f8ee3bab5c8c60cd0d3bea6c59615d74f5d156577b4ce3b8f1c74fa |
|
MD5 | 61a3eea4ca64f18338cf151c25f4180a |
|
BLAKE2b-256 | 09b5a178bc7e8b1137cf2fb52ff4e77b8d6aed6ea3226d14e0ead6aa1c201d1c |