Processes and automations for your Django project
Project description
Django-automations
A lightweight framework to collect all processes of your django app in one place.
Use cases:
- Marketing automations, customer journeys
- Simple business processes which require user interactions
- Running regular tasks
Django-automations works with plain Django but also integrates with Django-CMS.
Key features
-
Describe automations as python classes
-
Bind automations to models from other Django apps
-
Use Django forms for user interaction
-
Create transparency through extendable dashboard
-
Declare automations as unique or unique for a certain data set
-
Start automations on signals or when, e.g., user visits a page
-
Send messages between automations
Requirements
- Python: 3.7, 3.8, 3.9, 3.10
- Django: 3.0, 3.1, 3.2
Feedback
This project is in a early stage. All feedback is welcome! Please mail me at fsbraun(at)gmx.de
Installation
This project will be available on pypi after the first release. In the meantime, please install the master branch from git using
pip install https://github.com/fsbraun/django-automations/archive/master.zip
After installation add the automations
to your installed apps in settings.py
:
INSTALLED_APPS = (
...,
'automations',
'automations.cms_automations', # ONLY IF YOU USE DJANGO-CMS!
)
Only include the "sub app" automations.cms_automations
if you are using Django CMS.
The last step is to run the necessary migrations using the manage.py
command:
python manage.py migrate automations
Usage
The basic idea is to add an automation layer to Django's model, view, template structure. The automation layer collects in one place all business processes which in a Django app often are distributed across models, views and any glue code.
Automations consist of tasks which are carried out one after another. Modifiers affect, e.g. when a task is carried out.
from automations import flow
from automations.flow import this
# "this" can be used in a class definition as a replacement for "self"
from . import forms
class ProcessInput(Automation):
"""The process steps are defined by sequentially adding the corresponding nodes"""
start = flow.Execute(this.get_user_input) # Collect input a user has supplied
check = flow.If(
this.does_not_need_approval # Need approval?
).Then(this.process) # No? Continue later
approval = flow.Form(forms.ApprovalForm).Group(name="admins") # Let admins approve
process = flow.Execute(this.process_input) # Generate output
end = flow.End()
critical = 10_000
def get_user_input(task_instance):
...
def does_not_need_approval(task_instance):
return not (task_instance.data['amount'] > self.critical)
def process_input(task_instance):
...
Documentation
See the documentation on readthedocs.io.
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
File details
Details for the file django-automations-0.9.4.1.tar.gz
.
File metadata
- Download URL: django-automations-0.9.4.1.tar.gz
- Upload date:
- Size: 39.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a4653a1b1141149c3b173422080a94759f18e5feb98833d405dfb39b022343c |
|
MD5 | 19bf625052f08a54fc3fc3eccc9f93f4 |
|
BLAKE2b-256 | 0bed97cb4974ce37eda4a8c1818a286e3366a529d9228bca74555113536049e7 |
File details
Details for the file django_automations-0.9.4.1-py3-none-any.whl
.
File metadata
- Download URL: django_automations-0.9.4.1-py3-none-any.whl
- Upload date:
- Size: 56.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a60cfc73ac0488b5e3e7cabde7f8cea3a22b60edfbe8ae2b77f32bb112caff2e |
|
MD5 | a4db0c4cc5f1fd868d23fe0cf0427467 |
|
BLAKE2b-256 | 7f3cfd5d93b5110dd7d9196791225186d450662072f7711be3144cd28cc7e0bb |