A Django app that allows creation of conditional logic in admin.
Project description
django-conditions
Move conditional logic that changes often from code into models so that the logic can be easily modified in admin. Some possible use cases:
- Segment your user base into cohorts with targeted messaging
- Provide different rewards to users depending on their expected value
- In a game, define the winning objectives of a mission/quest
- and many more...
Installation
First install the django-conditions
package:
pip install django-conditions
Then add conditions
to your INSTALLED_APPS
setting:
## settings.py
INSTALLED_APPS = [
...
'conditions',
]
Basic Usage
Start by defining a condition in code:
## condition_types.py
from conditions import Condition
class FullName(Condition):
# The name that appears in the db and represents your condition
condstr = 'FULL_NAME'
# Normal conditions define eval_bool, which takes in a user
# and returns a boolean
def eval_bool(self, user, **kwargs):
return bool(user.first_name and user.last_name)
Then add a ConditionsField to your model:
## models.py
from django.db import models
from conditions import ConditionsField, conditions_from_module
import condition_types
class Campaign(models.Model):
text = models.TextField()
# The ConditionsField requires the definitions of all possible conditions
# conditions_from_module can take an imported module and sort this out for you
target = ConditionsField(definitions=conditions_from_module(condition_types))
In the model's change form on admin, you can enter JSON to represent when you want your condition to be satisfied.
{
"all": ["FULL_NAME"]
}
Now you can use the logic you created in admin to determine the outcome of an event:
## views.py
from django.http import HttpResponse
from conditions import eval_conditions
from models import Campaign
def profile(request):
for campaign in Campaign.objects.all():
if eval_conditions(campaign, 'target', request.user):
return HttpReponse(campaign.text)
return HttpResponse("Nothing new to see.")
Use django-conditions in your Django projects to change simple logic without having to re-deploy, and pass on the power to product managers and other non-engineers.
More Information
Full documentation is available on Read The Docs.
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
Hashes for django-conditions-0.9.16.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f4687fba44fed4a20e19e441938f5ead9f3bf32ba0bf84cbaa4554aa539acf6 |
|
MD5 | 14af5202799318b13f1c655ea2f35917 |
|
BLAKE2b-256 | bafb26b80b7e7523cbeae5a6bc282b598fe5c36db478b1fa7bba7f317b78b9d9 |