django-rule-engine 1.0.1

Django field and widget for rule-engine with visual editor

Django rule-engine - Field, Widget & API

A powerful Django field and widget that brings rule-engine to your Django projects with a beautiful visual editor, real-time validation, and a clean API.

Perfect for building flexible business rules, access control policies, discount conditions, validation rules, and any scenario where you need dynamic, user-configurable logic.

✨ Key Features

🎨 Visual Rule Editor

• Syntax highlighting for better readability
• Real-time validation with immediate feedback
• Auto-formatting for JSON example data
• Keyboard shortcuts (Ctrl+Enter to validate)
• Dark mode support with modern UI

🔌 Easy Integration

from django_rule_engine.fields import RuleField

class MyModel(models.Model):
    access_rule = RuleField(
        verbose_name="Access Rule",
        example_data={
            "age": 25,
            "status": "active",
            "role": "admin"
        }
    )

⚡ REST API

Built-in validation endpoint for frontend validation:

POST /api/validate-rule/

🎯 Django Admin Integration

Seamlessly integrates with Django Admin - just add the field and the editor appears automatically!

📦 Installation

pip install django-rule-engine

Add to your INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    'django_rule_engine',
]

Include URLs:

urlpatterns = [
    path('', include('django_rule_engine.urls')),
]

💡 Use Cases

• ✅ Access Control: Define who can access resources
• ✅ Business Rules: Implement complex discount/pricing logic
• ✅ Validation: Create dynamic validation rules
• ✅ Eligibility: Determine program/service eligibility
• ✅ Classification: Classify entities based on criteria
• ✅ Filtering: Advanced data filtering and queries

🎓 Quick Example

from django.db import models
from django_rule_engine.fields import RuleField

class DiscountCampaign(models.Model):
    name = models.CharField(max_length=200)
    
    rule = RuleField(
        verbose_name="Discount Rule",
        example_data={
            "price": 150.00,
            "quantity": 3,
            "customer_type": "premium",
            "first_purchase": False
        },
        help_text="Example: price > 100 and quantity >= 2"
    )
    
    discount_percentage = models.DecimalField(max_digits=5, decimal_places=2)

    def calculate_discount(self, order_data):
        """Calculate discount based on the rule."""
        if not self.rule:
            return 0
        
        import rule_engine
        rule = rule_engine.Rule(self.rule)
        
        if rule.matches(order_data):
            return float(self.discount_percentage)
        return 0

📚 Documentation

Comprehensive documentation is included in the package:

• INSTALL.md - Installation and setup guide
• QUICKSTART.md - Get started in 5 minutes
• EXAMPLES.md - Real-world code examples
• MIGRATION_GUIDE.md - Migrate existing projects
• VISUAL_DEMO.md - Visual demonstration
• INDEX.md - Complete documentation index

🔧 Requirements

• Python >= 3.10
• Django >= 4.2
• rule-engine >= 4.5.3
• django-json-widget >= 2.0

🎯 Tested On

• Python: 3.10, 3.11, 3.12, 3.13, 3.14
• Django: 4.2, 5.0, 5.1, 5.2
• Modern browsers (Chrome, Firefox, Safari, Edge)

Validation API

REST endpoint for dynamically validating rule-engine rules.

• Endpoint: POST /api/validate-rule/
• Documentation: fields/README.md

🚀 Quick Start

1. Import and Use

from django_rule_engine.fields import RuleField

class MyModel(models.Model):
    rule = RuleField(
        example_data={"age": 25, "status": "active"}
    )

📚 Documentation

1. INDEX.md - Complete documentation index
2. INSTALL.md - Installation guide
3. QUICKSTART.md - Quick start (5 min)
4. MIGRATION_GUIDE.md - Migration guide
5. EXAMPLES.md - Code examples
6. VISUAL_DEMO.py - Demonstração Visual

🎯 Implementation Example

The field is already being used in the Cohort model in coorte/models.py:

class Cohort(Model):
    name = CharField("cohort name", max_length=256, unique=True)
    rule = RuleField(
        "validation rule",
        blank=True,
        null=True,
        example_data={
            "login": "user123",
            "user": {"email": "[e-mail]"},
            "name": "Zé da Silva",
            "active": True
        },
        default="login == 'user123' and user.email != '[e-mail]'",
    )

    class Meta:
        verbose_name = _("cohort")
        verbose_name_plural = _("cohorts")
        ordering = ["name"]

    def __str__(self):
        return self.name