Skip to main content

Phoenix LiveView-style reactive components for Django with Rust-powered performance. Real-time UI updates over WebSocket, no JavaScript build step required.

Project description

djust

Blazing fast reactive server-side rendering for Django, powered by Rust

djust brings Phoenix LiveView-style reactive components to Django, with performance that feels native. Write server-side Python code with automatic, instant client updates—no JavaScript bundling, no build step, no complexity.

🌐 djust.org | 📚 docs.djust.org | 🚀 Quick Start | 📝 Examples

PyPI version CI MIT License Python 3.10+ Django 3.2+ PyPI Downloads

✨ Features

  • 10-100x Faster - Rust-powered template engine and Virtual DOM diffing
  • 🔄 Reactive Components - Phoenix LiveView-style server-side reactivity
  • 🔌 Django Compatible - Works with existing Django templates and components
  • 📦 Zero Build Step - ~29KB gzipped client JavaScript, no bundling needed
  • 🌐 WebSocket Updates - Real-time DOM patches over WebSocket (with HTTP fallback)
  • 🎯 Minimal Client Code - Smart diffing sends only what changed
  • 🔒 Type Safe - Rust guarantees for core performance-critical code
  • 🐞 Developer Debug Panel - Interactive debugging with event history and VDOM inspection
  • 💤 Lazy Hydration - Defer WebSocket connections for below-fold content (20-40% memory savings)
  • 🚀 TurboNav Compatible - Works seamlessly with Turbo-style client-side navigation
  • 📱 PWA Support - Offline-first Progressive Web Apps with automatic sync
  • 🏢 Multi-Tenant Ready - Production SaaS architecture with tenant isolation
  • 🔐 Authentication & Authorization - View-level and handler-level auth with Django permissions integration

🎯 Quick Example

from djust import LiveView, event_handler

class CounterView(LiveView):
    template_string = """
    <div>
        <h1>Count: {{ count }}</h1>
        <button dj-click="increment">+</button>
        <button dj-click="decrement">-</button>
    </div>
    """

    def mount(self, request, **kwargs):
        self.count = 0

    @event_handler
    def increment(self):
        self.count += 1  # Automatically updates client!

    @event_handler
    def decrement(self):
        self.count -= 1

That's it! No JavaScript needed. State changes automatically trigger minimal DOM updates.

🔄 How Reactivity Works

djust uses a Rust-powered Virtual DOM (VDOM) to diff server-rendered HTML and send only the changed patches over WebSocket. Understanding a few core attributes makes everything click.

Template Anatomy

{% load djust_tags %}
<!DOCTYPE html>
<html>
<head>
    {% djust_scripts %}              {# Loads ~5KB client JavaScript #}
</head>
<body dj-view="{{ dj_view_id }}">   {# Identifies the WebSocket session #}
    <div dj-root>                    {# Reactive boundary — only this is diffed #}
        <h1>Count: {{ count }}</h1>
        <button dj-click="increment">+</button>
    </div>
    {# Static content outside dj-root is never touched by VDOM patching #}
</body>
</html>
Attribute Where Purpose
{% djust_scripts %} <head> Injects client JavaScript
dj-view="{{ dj_view_id }}" <body> Connects page to WebSocket session
dj-root Inner <div> Marks the reactive region; only HTML inside is diffed and patched

Stable List Identity

For lists that can reorder or have items inserted/deleted, add data-key or dj-key on each item. djust uses this to emit MoveChild patches instead of remove-then-insert pairs — preserving DOM state (focus, scroll position, animations):

{% for item in items %}
<div data-key="{{ item.id }}">
    {{ item.name }}
    <button dj-click="delete" data-item-id="{{ item.id }}">Delete</button>
</div>
{% endfor %}

Without a key, djust diffs by position — correct, but produces more DOM mutations for reorders.

Common Pitfall: One-Sided {% if %} in Class Attributes

Using {% if %} without {% else %} inside an HTML attribute value can cause VDOM patching misalignment due to djust's branch-aware div-depth counting:

{# WRONG: one-sided if inside class attribute #}
<div class="card {% if active %}active{% endif %}">

{# CORRECT: use full if/else #}
<div class="card {% if active %}active{% else %}{% endif %}">

{# ALSO CORRECT: move conditional outside the tag #}
{% if active %}
<div class="card active">
{% else %}
<div class="card">
{% endif %}
    ...
</div>

This applies only to attribute values — {% if %} blocks in element content work fine.

See the VDOM Architecture guide and Template Cheat Sheet for full details.

🚀 Getting Started

Here's a complete walkthrough from zero to a working reactive counter in 5 steps.

Step 1 — Install

pip install djust django-channels

Step 2 — Add to INSTALLED_APPS and configure settings

In myproject/settings.py:

INSTALLED_APPS = [
    # ... your existing apps ...
    'channels',   # WebSocket support
    'djust',
]

ASGI_APPLICATION = 'myproject.asgi.application'

CHANNEL_LAYERS = {
    'default': {
        'BACKEND': 'channels.layers.InMemoryChannelLayer',
    }
}

Step 3 — Configure asgi.py

Replace myproject/asgi.py with:

import os
from django.core.asgi import get_asgi_application
from channels.routing import ProtocolTypeRouter, URLRouter
from channels.auth import AuthMiddlewareStack
from djust.websocket import LiveViewConsumer
from django.urls import path

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'myproject.settings')

application = ProtocolTypeRouter({
    "http": get_asgi_application(),
    "websocket": AuthMiddlewareStack(
        URLRouter([
            path('ws/live/', LiveViewConsumer.as_asgi()),
        ])
    ),
})

Step 4 — Add the URL route

In myproject/urls.py:

from django.urls import path
from myapp.views import CounterView

urlpatterns = [
    path('counter/', CounterView.as_live_view(), name='counter'),
]

Step 5 — Write the view and template

myapp/views.py:

from djust import LiveView, event_handler

class CounterView(LiveView):
    template_name = 'counter.html'

    def mount(self, request, **kwargs):
        self.count = 0

    @event_handler
    def increment(self):
        self.count += 1

    @event_handler
    def decrement(self):
        self.count -= 1

myapp/templates/counter.html:

{% load djust_tags %}
<!DOCTYPE html>
<html>
<head>
    <title>Counter</title>
    {% djust_scripts %}
</head>
<body dj-view="{{ dj_view_id }}">
    <div dj-root>
        <h1>Count: {{ count }}</h1>
        <button dj-click="increment">+</button>
        <button dj-click="decrement">-</button>
    </div>
</body>
</html>

Run with uvicorn myproject.asgi:application --reload and open /counter/. Clicking the buttons updates the count without a page reload — no JavaScript written, no build step.

Next steps:


📊 Performance

Benchmarked on M1 MacBook Pro (2021):

Operation Django djust Speedup
Template Rendering (100 items) 2.5 ms 0.15 ms 16.7x
Large List (10k items) 450 ms 12 ms 37.5x
Virtual DOM Diff N/A 0.08 ms Sub-ms
Round-trip Update 50 ms 5 ms 10x

Run benchmarks yourself:

cd benchmarks
python benchmark.py

🚀 Installation

Prerequisites

  • Python 3.10+
  • Rust 1.70+ (for building from source)
  • Django 3.2+

Install from PyPI

pip install djust

Build from Source

Using Make (Easiest - Recommended for Development)

# Clone the repository
git clone https://github.com/djust-org/djust.git
cd djust

# Install Rust (if needed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install everything and build
make install

# Start the development server
make start

# See all available commands
make help

Common Make Commands:

  • make start - Start development server with hot reload
  • make stop - Stop the development server
  • make status - Check if server is running
  • make test - Run all tests
  • make clean - Clean build artifacts
  • make help - Show all available commands

Using uv (Fast)

# Clone the repository
git clone https://github.com/djust-org/djust.git
cd djust

# Install Rust (if needed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install uv (if needed)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Create virtual environment and install dependencies
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install maturin and build
uv pip install maturin
maturin develop --release

Using pip

# Clone the repository
git clone https://github.com/djust-org/djust.git
cd djust

# Install Rust (if needed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install maturin
pip install maturin

# Build and install
maturin develop --release

# Or build wheel
maturin build --release
pip install target/wheels/djust-*.whl

📖 Documentation

Setup

  1. Add to INSTALLED_APPS:
INSTALLED_APPS = [
    # ...
    'channels',  # Required for WebSocket support
    'djust',
    # ...
]
  1. Configure ASGI application (asgi.py):
import os
from django.core.asgi import get_asgi_application
from channels.routing import ProtocolTypeRouter, URLRouter
from channels.auth import AuthMiddlewareStack
from djust.websocket import LiveViewConsumer
from django.urls import path

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'myproject.settings')

application = ProtocolTypeRouter({
    "http": get_asgi_application(),
    "websocket": AuthMiddlewareStack(
        URLRouter([
            path('ws/live/', LiveViewConsumer.as_asgi()),
        ])
    ),
})
  1. Add to settings.py:
ASGI_APPLICATION = 'myproject.asgi.application'

CHANNEL_LAYERS = {
    'default': {
        'BACKEND': 'channels.layers.InMemoryChannelLayer'
    }
}

Creating LiveViews

Class-Based LiveView

from djust import LiveView, event_handler

class TodoListView(LiveView):
    template_name = 'todos.html'  # Or use template_string

    def mount(self, request, **kwargs):
        """Called when view is first loaded"""
        self.todos = []

    @event_handler
    def add_todo(self, text):
        """Event handler - called from client"""
        self.todos.append({'text': text, 'done': False})

    @event_handler
    def toggle_todo(self, index):
        self.todos[index]['done'] = not self.todos[index]['done']

Function-Based LiveView

from djust import live_view

@live_view(template_name='counter.html')
def counter_view(request):
    count = 0

    def increment():
        nonlocal count
        count += 1

    return locals()  # Returns all local variables as context

Template Syntax

djust supports Django template syntax with event binding:

<!-- Variables -->
<h1>{{ title }}</h1>

<!-- Filters (all 57 Django built-in filters supported) -->
<p>{{ text|upper }}</p>
<p>{{ description|truncatewords:20 }}</p>
<a href="?q={{ query|urlencode }}">Search</a>
{{ body|urlize }}  {# No |safe needed — djust's Rust engine auto-marks urlize output as safe via safe_output_filters. Unlike standard Django where you'd add |safe, djust handles this automatically. #}

<!-- Control flow -->
{% if show %}
    <div>Visible</div>
{% endif %}

{% if count > 10 %}
    <div>Many items!</div>
{% endif %}

{% for item in items %}
    <li>{{ item }}</li>
{% endfor %}

<!-- URL resolution -->
<a href="{% url 'myapp:detail' pk=item.id %}">View</a>

<!-- Template includes -->
{% include "partials/header.html" %}

<!-- Event binding -->
<button dj-click="increment">Click me</button>
<input dj-input="on_search" type="text" />
<form dj-submit="submit_form">
    <input name="email" />
    <button type="submit">Submit</button>
</form>

Django migration note: In standard Django, urlize requires |safe to render its HTML output. djust's Rust template engine automatically marks urlize, urlizetrunc, and unordered_list as safe (via safe_output_filters in the renderer) because these filters handle their own HTML escaping internally. Adding |safe after them is unnecessary.

Supported Events

  • dj-click - Click events
  • dj-input - Input events (passes value)
  • dj-change - Change events (passes value)
  • dj-submit - Form submission (passes form data as dict)

Reusable Components

djust provides a powerful component system with automatic state management and stable component IDs.

Basic Component Example

from djust.components import AlertComponent

class MyView(LiveView):
    def mount(self, request):
        # Components get automatic IDs based on attribute names
        self.alert_success = AlertComponent(
            message="Operation successful!",
            type="success",
            dismissible=True
        )
        # component_id automatically becomes "alert_success"

Component ID Management

Components automatically receive a stable component_id based on their attribute name in your view. This eliminates manual ID management:

# When you write:
self.alert_success = AlertComponent(message="Success!")

# The framework automatically:
# 1. Sets component.component_id = "alert_success"
# 2. Persists this ID across renders and events
# 3. Uses it in HTML: data-component-id="alert_success"
# 4. Routes events back to the correct component

Why it works:

  • The attribute name (alert_success) is already unique within your view
  • It's stable across re-renders and WebSocket reconnections
  • Event handlers can reference components by their attribute names
  • No manual ID strings to keep in sync

Event Routing Example:

class MyView(LiveView):
    def mount(self, request):
        self.alert_warning = AlertComponent(
            message="Warning message",
            dismissible=True
        )

    @event_handler
    def dismiss(self, component_id: str = None):
        """Handle dismissal - automatically routes to correct component"""
        if component_id and hasattr(self, component_id):
            component = getattr(self, component_id)
            if hasattr(component, 'dismiss'):
                component.dismiss()  # component_id="alert_warning"

When the dismiss button is clicked, the client sends component_id="alert_warning", and the handler uses getattr(self, "alert_warning") to find the component.

Creating Custom Components

from djust import Component, register_component, event_handler

@register_component('my-button')
class Button(Component):
    template = '<button dj-click="on_click">{{ label }}</button>'

    def __init__(self, label="Click"):
        super().__init__()
        self.label = label
        self.clicks = 0

    @event_handler
    def on_click(self):
        self.clicks += 1
        print(f"Clicked {self.clicks} times!")

Decorators

from djust import LiveView, event_handler, reactive

class MyView(LiveView):
    @event_handler
    def handle_click(self):
        """Marks method as event handler"""
        pass

    @reactive
    def count(self):
        """Reactive property - auto-triggers updates"""
        return self._count

    @count.setter
    def count(self, value):
        self._count = value

Configuration

Configure djust in your Django settings.py:

LIVEVIEW_CONFIG = {
    # Transport mode
    'use_websocket': True,  # Set to False for HTTP-only mode (no WebSocket dependency)

    # Debug settings
    'debug_vdom': False,  # Enable detailed VDOM patch logging (for troubleshooting)

    # Serialization (issue #292)
    'strict_serialization': False,  # Raise TypeError for non-serializable state values (recommended in development)

    # CSS Framework
    'css_framework': 'bootstrap5',  # Options: 'bootstrap5', 'tailwind', None
}

Common Configuration Options:

Option Default Description
use_websocket True Use WebSocket transport (requires Django Channels)
debug_vdom False Enable detailed VDOM debugging logs
strict_serialization False Raise TypeError for non-serializable state (recommended in dev)
css_framework 'bootstrap5' CSS framework for components

CSS Framework Setup:

For Tailwind CSS (recommended), use the one-command setup:

python manage.py djust_setup_css tailwind

This auto-detects template directories, creates config files, and builds your CSS. For production:

python manage.py djust_setup_css tailwind --minify

See the CSS Framework Guide for detailed setup instructions, Bootstrap configuration, and CI/CD integration.

Debug Mode:

When troubleshooting VDOM issues, enable debug logging:

# In settings.py
LIVEVIEW_CONFIG = {
    'debug_vdom': True,
}

# Or programmatically
from djust.config import config
config.set('debug_vdom', True)

This will log:

  • Server-side: Patch generation details (stderr)
  • Client-side: Patch application and DOM traversal (browser console)

State Management

djust provides Python-only state management decorators that eliminate the need for manual JavaScript.

🚀 Quick Start (5 minutes)

Build a debounced search in 8 lines of Python (no JavaScript):

from djust import LiveView
from djust.decorators import debounce

class ProductSearchView(LiveView):
    template_string = """
    <input dj-input="search" placeholder="Search products..." />
    <div>{% for p in results %}<div>{{ p.name }}</div>{% endfor %}</div>
    """

    def mount(self, request):
        self.results = []

    @debounce(wait=0.5)  # Wait 500ms after typing stops
    def search(self, query: str = "", **kwargs):
        self.results = Product.objects.filter(name__icontains=query)[:10]

That's it! Server only queries after you stop typing. Add @optimistic for instant UI updates, @cache(ttl=300) to cache responses for 5 minutes.

👉 Full Quick Start Guide (5 min)


Key Features

  • Zero JavaScript Required - Common patterns work without writing any JS
  • 87% Code Reduction - Decorators replace hundreds of lines of manual JavaScript
  • Lightweight Bundle - ~29KB gzipped client.js (vs Livewire ~50KB)
  • Competitive DX - Matches Phoenix LiveView and Laravel Livewire developer experience

Available Decorators

Decorator Use When Example
@debounce(wait) User is typing Search, autosave
@throttle(interval) Rapid events Scroll, resize
@optimistic Instant feedback Counter, toggle
@cache(ttl, key_params) Repeated queries Autocomplete
@client_state(keys) Multi-component Dashboard filters
@background Long operations AI generation, file processing
DraftModeMixin Auto-save forms Contact form

Quick Decision Matrix:

  • Typing in input? → @debounce(0.5)
  • Scrolling/resizing? → @throttle(0.1)
  • Need instant UI update? → @optimistic
  • Same query multiple times? → @cache(ttl)
  • Multiple components? → @client_state([keys])
  • Long-running work? → @background or self.start_async(callback)
  • Auto-save forms? → DraftModeMixin

Learn More

🧭 Navigation Patterns

djust provides three navigation mechanisms for building multi-view applications without full page reloads:

When to Use What

Scenario Use Why
Filter/sort/paginate within same view dj-patch / live_patch() No remount, URL stays bookmarkable
Navigate to a different LiveView dj-navigate / live_redirect() Same WebSocket, no page reload
Link to non-LiveView page Standard <a href> Full page load needed

Quick Decision Tree

Use this flowchart when choosing a navigation method:

Is this a direct user click on a link?
├─ Yes → Is it the same view (filter/sort)?
│   ├─ Yes → Use dj-patch
│   └─ No → Use dj-navigate
│
└─ No → Is navigation conditional on server logic?
    ├─ Yes → Use live_redirect() in @event_handler
    │   Examples: form validation, auth checks, async operations
    └─ No → You probably need dj-navigate (see anti-pattern below)

⚠️ Anti-Pattern: Don't Use dj-click for Navigation

This is the most common mistake when building multi-view djust apps. Using dj-click to trigger a handler that immediately calls live_redirect() creates an unnecessary round-trip.

❌ Wrong — using dj-click to trigger a handler that calls live_redirect():

# Anti-pattern: Handler does nothing but navigate
@event_handler()
def go_to_item(self, item_id, **kwargs):
    self.live_redirect(f"/items/{item_id}/")  # Wasteful round-trip!
<!-- Wrong: Forces WebSocket round-trip just to navigate -->
<button dj-click="go_to_item" dj-value-item_id="{{ item.id }}">View</button>

What actually happens:

  1. User clicks button → Client sends WebSocket message (50-100ms)
  2. Server receives message, processes handler (10-50ms)
  3. Server responds with live_redirect command (50-100ms)
  4. Client finally navigates to new view Total: 110-250ms + handler processing time

✅ Right — using dj-navigate directly:

<!-- Right: Client navigates immediately, no server round-trip -->
<a dj-navigate="/items/{{ item.id }}/">View Item</a>

What happens:

  1. User clicks link → Client navigates directly Total: ~10ms (just DOM updates)

Why it matters:

  • Performance: 10-20x faster navigation
  • Network efficiency: Saves WebSocket bandwidth
  • User experience: Instant response, no loading indicators needed
  • Simplicity: Less code, fewer moving parts

When to Use live_redirect() in Handlers

Use handlers for navigation only when navigation depends on server-side logic or validation:

✅ Conditional navigation after form validation:

@event_handler()
def submit_form(self, **kwargs):
    if self.form.is_valid():
        self.form.save()
        self.live_redirect("/success/")  # OK: Conditional on validation
    else:
        # Stay on form to show errors
        pass

✅ Navigation based on auth/permissions:

@event_handler()
def view_sensitive_data(self, **kwargs):
    if not self.request.user.has_perm('app.view_sensitive'):
        self.live_redirect("/access-denied/")  # OK: Auth check required
        return
    self.show_sensitive = True

✅ Navigation after async operations:

@event_handler()
async def create_and_view_item(self, name, **kwargs):
    item = await Item.objects.acreate(name=name, owner=self.request.user)
    self.live_redirect(f"/items/{item.id}/")  # OK: Navigate to newly created item

✅ Multi-step wizard logic:

@event_handler()
def next_step(self, **kwargs):
    if self.current_step == "payment" and not self.payment_valid:
        # Stay on payment step if invalid
        return
    self.current_step = self.get_next_step()
    self.live_patch(params={"step": self.current_step})  # OK: Conditional flow

Common theme: The handler does meaningful work before navigating. If your handler only calls live_redirect(), use dj-navigate instead.

Quick Example: Multi-View App

from djust import LiveView
from djust.mixins.navigation import NavigationMixin
from djust.decorators import event_handler

class ProductListView(NavigationMixin, LiveView):
    template_string = """
    <!-- Filter within same view: use dj-patch -->
    <a dj-patch="?category=electronics">Electronics</a>
    <a dj-patch="?category=books">Books</a>

    <div>
        {% for product in products %}
            <!-- Navigate to different view: use dj-navigate -->
            <a dj-navigate="/products/{{ product.id }}/">{{ product.name }}</a>
        {% endfor %}
    </div>
    """

    def mount(self, request, **kwargs):
        self.category = "all"
        self.products = []

    def handle_params(self, params, uri):
        """Called when URL changes via dj-patch or browser back/forward"""
        self.category = params.get("category", "all")
        self.products = Product.objects.filter(category=self.category)

Learn More:

  • 📖 Navigation Guide - Complete API reference (live_patch(), live_redirect(), handle_params())

Developer Tooling

Debug Panel

Interactive debugging tool for LiveView development (DEBUG mode only):

# In settings.py
DEBUG = True  # Debug panel automatically enabled

Open: Press Ctrl+Shift+D (Windows/Linux) or Cmd+Shift+D (Mac), or click the 🐞 floating button

Features:

  • 🔍 Event Handlers - Discover all handlers with parameters, types, and descriptions
  • 📊 Event History - Real-time log with timing metrics (e.g., search • 45.2ms)
  • VDOM Patches - Monitor DOM updates with sub-millisecond precision
  • 🔬 Variables - Inspect current view state

Learn More:

Event Handlers

Always use @event_handler decorator for auto-discovery and validation:

from djust.decorators import event_handler

@event_handler()
def search(self, value: str = "", **kwargs):
    """Search handler - description shown in debug panel"""
    self.search_query = value

Parameter Convention: Use value for form inputs (dj-input, dj-change events):

# ✅ Correct - matches what form events send
@event_handler()
def search(self, value: str = "", **kwargs):
    self.search_query = value

# ❌ Wrong - won't receive input value
@event_handler()
def search(self, query: str = "", **kwargs):
    self.search_query = query  # Always "" (default)

🏗️ Architecture

┌─────────────────────────────────────────────┐
│  Browser                                    │
│  ├── Client.js (~29KB gz) - Events & DOM   │
│  └── WebSocket Connection                   │
└─────────────────────────────────────────────┘
           ↕️ WebSocket (Binary/JSON)
┌─────────────────────────────────────────────┐
│  Django + Channels (Python)                 │
│  ├── LiveView Classes                       │
│  ├── Event Handlers                         │
│  └── State Management                       │
└─────────────────────────────────────────────┘
           ↕️ Python/Rust FFI (PyO3)
┌─────────────────────────────────────────────┐
│  Rust Core (Native Speed)                   │
│  ├── Template Engine (<1ms)                │
│  ├── Virtual DOM Diffing (<100μs)          │
│  ├── HTML Parser                            │
│  └── Binary Serialization (MessagePack)    │
└─────────────────────────────────────────────┘

🎨 Examples

See the examples/demo_project directory for complete working examples:

  • Counter - Simple reactive counter
  • Todo List - CRUD operations with lists
  • Chat - Real-time messaging

Run the demo:

cd examples/demo_project
pip install -r requirements.txt
python manage.py migrate
python manage.py runserver

Visit http://localhost:8000

🔧 Development

Project Structure

djust/
├── crates/
│   ├── djust_core/        # Core types & utilities
│   ├── djust_templates/   # Template engine
│   ├── djust_vdom/        # Virtual DOM & diffing
│   ├── djust_components/  # Reusable component library
│   └── djust_live/        # Main PyO3 bindings
├── python/
│   └── djust/             # Python package
│       ├── live_view.py         # LiveView base class
│       ├── component.py         # Component system
│       ├── websocket.py         # WebSocket consumer
│       └── static/
│           └── client.js        # Client runtime
├── branding/                    # Logo and brand assets
├── examples/                    # Example projects
├── benchmarks/                  # Performance benchmarks
└── tests/                       # Tests

Running Tests

# All tests (Python + Rust + JavaScript)
make test

# Individual test suites
make test-python       # Python tests
make test-rust         # Rust tests
make test-js           # JavaScript tests

# Specific tests
pytest tests/unit/test_live_view.py
cargo test --workspace --exclude djust_live

For comprehensive testing documentation, see Testing Guide.

Building Documentation

cargo doc --open

💰 Supporting djust

djust is open source (MIT licensed) and free forever. If you're using djust in production or want to support development:

  • Star this repo - Help others discover djust
  • 💜 GitHub Sponsors - Monthly support from $5/month

Your support helps us maintain and improve djust for everyone!

🤝 Contributing

Contributions welcome! Please read CONTRIBUTING.md first.

Areas we'd love help with:

  • More example applications
  • Performance optimizations
  • Documentation improvements
  • Browser compatibility testing

📝 Roadmap

  • Template inheritance ({% extends %})
  • {% url %} and {% include %} tags
  • Comparison operators in {% if %} tags
  • All 57 Django built-in template filters
  • Security hardening (WebSocket origin validation, HMAC signing, rate limiting)
  • Developer debug panel with event history and VDOM inspection
  • Reusable component library (djust_components crate)
  • JIT pipeline improvements and stale-closure fixes
  • Authentication & authorization (view-level + handler-level)
  • File upload handling
  • Server-sent events (SSE) fallback
  • React/Vue component compatibility
  • TypeScript definitions (djust.d.ts shipped with the package)
  • Redis-backed session storage
  • Horizontal scaling support

🔒 Security

  • CSRF protection via Django middleware
  • XSS protection via automatic template escaping (Rust engine escapes all variables by default)
  • HTML-producing filters (urlize, urlizetrunc, unordered_list) handle their own escaping internally — the Rust engine's safe_output_filters whitelist prevents double-escaping, so |safe is never needed with these filters
  • WebSocket authentication via Django sessions
  • WebSocket origin validation and HMAC message signing (v0.2.1)
  • Per-view and global rate limiting support
  • Configurable allowed origins for WebSocket connections
  • View-level auth enforcement (login_required, permission_required) before mount()
  • Handler-level @permission_required for protecting individual event handlers
  • djust_audit command and djust.S005 system check for auth posture visibility

Report security issues to: security@djust.org

📄 License

MIT License - see LICENSE file for details.

🙏 Acknowledgments

  • Inspired by Phoenix LiveView
  • Built with PyO3 for Python/Rust interop
  • Uses html5ever for HTML parsing
  • Powered by the amazing Rust and Django communities

💬 Community & Support


djust.org — Made with ❤️ by the djust community

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

djust-0.9.6rc2.tar.gz (4.9 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

djust-0.9.6rc2-cp314-cp314-win_amd64.whl (7.4 MB view details)

Uploaded CPython 3.14Windows x86-64

djust-0.9.6rc2-cp314-cp314-manylinux_2_34_x86_64.whl (7.4 MB view details)

Uploaded CPython 3.14manylinux: glibc 2.34+ x86-64

djust-0.9.6rc2-cp314-cp314-macosx_11_0_arm64.whl (7.1 MB view details)

Uploaded CPython 3.14macOS 11.0+ ARM64

djust-0.9.6rc2-cp314-cp314-macosx_10_12_x86_64.whl (7.3 MB view details)

Uploaded CPython 3.14macOS 10.12+ x86-64

djust-0.9.6rc2-cp313-cp313-win_amd64.whl (7.4 MB view details)

Uploaded CPython 3.13Windows x86-64

djust-0.9.6rc2-cp313-cp313-manylinux_2_34_x86_64.whl (7.4 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.34+ x86-64

djust-0.9.6rc2-cp313-cp313-macosx_11_0_arm64.whl (7.1 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

djust-0.9.6rc2-cp313-cp313-macosx_10_12_x86_64.whl (7.3 MB view details)

Uploaded CPython 3.13macOS 10.12+ x86-64

djust-0.9.6rc2-cp312-cp312-win_amd64.whl (7.4 MB view details)

Uploaded CPython 3.12Windows x86-64

djust-0.9.6rc2-cp312-cp312-manylinux_2_34_x86_64.whl (7.4 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.34+ x86-64

djust-0.9.6rc2-cp312-cp312-macosx_11_0_arm64.whl (7.1 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

djust-0.9.6rc2-cp312-cp312-macosx_10_12_x86_64.whl (7.3 MB view details)

Uploaded CPython 3.12macOS 10.12+ x86-64

djust-0.9.6rc2-cp311-cp311-win_amd64.whl (7.4 MB view details)

Uploaded CPython 3.11Windows x86-64

djust-0.9.6rc2-cp311-cp311-manylinux_2_34_x86_64.whl (7.4 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.34+ x86-64

djust-0.9.6rc2-cp311-cp311-macosx_11_0_arm64.whl (7.1 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

djust-0.9.6rc2-cp311-cp311-macosx_10_12_x86_64.whl (7.3 MB view details)

Uploaded CPython 3.11macOS 10.12+ x86-64

djust-0.9.6rc2-cp310-cp310-manylinux_2_34_x86_64.whl (7.4 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.34+ x86-64

File details

Details for the file djust-0.9.6rc2.tar.gz.

File metadata

  • Download URL: djust-0.9.6rc2.tar.gz
  • Upload date:
  • Size: 4.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for djust-0.9.6rc2.tar.gz
Algorithm Hash digest
SHA256 38ae0f8e3058d471ee95d0fcf9b77dd47b29758708c15cee16bd848bc90f51e7
MD5 6d54ad839d3757fc879d5656c8ce9705
BLAKE2b-256 501b3b9681dee8853c7c2e2cea4c9254c1eeec227e284eed98a64993ee85bcae

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2.tar.gz:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp314-cp314-win_amd64.whl.

File metadata

  • Download URL: djust-0.9.6rc2-cp314-cp314-win_amd64.whl
  • Upload date:
  • Size: 7.4 MB
  • Tags: CPython 3.14, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for djust-0.9.6rc2-cp314-cp314-win_amd64.whl
Algorithm Hash digest
SHA256 fb51a3034dd24eb69961493f96f84d25955fbbd79ba8ee35e84d9ccb5ad8ca38
MD5 c1592d0c80b85b3c6e23f6f774a071cd
BLAKE2b-256 20916dca9710a5f3be78606fa035ab38f973646786e5973ba2aeb89d5c273dae

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp314-cp314-win_amd64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp314-cp314-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp314-cp314-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 81f7192e47fb584dc0b28be82578b7a6024b440d4733a81fe6dc9aef96de3866
MD5 75f822bda79d055c771b83a8fb150cc6
BLAKE2b-256 a8e004590954ef84d2059904748a75fcd0e7073e7e5245775eea484757abd52c

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp314-cp314-manylinux_2_34_x86_64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp314-cp314-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp314-cp314-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cd03cb1b5f4168ef2543ffaab8d0482da4aa8b1d0af497e751742e868108fb05
MD5 ba3c04b695c36ccbd31a1387c20527a0
BLAKE2b-256 6e28b258d67b0d04749e56ea07cb4f8d722fcc0e418463405075191fbad8886b

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp314-cp314-macosx_11_0_arm64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp314-cp314-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp314-cp314-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 7b5420b231d55105cdaba07a5b581abfd88269c21cf631ceb58a412e9ad1f4e0
MD5 cc9a3075646307613142faa2c7c8f152
BLAKE2b-256 0b3ef9faf188c83502441db06e3a965d262fe31fcbd7571834019f30c0f49993

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp314-cp314-macosx_10_12_x86_64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp313-cp313-win_amd64.whl.

File metadata

  • Download URL: djust-0.9.6rc2-cp313-cp313-win_amd64.whl
  • Upload date:
  • Size: 7.4 MB
  • Tags: CPython 3.13, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for djust-0.9.6rc2-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 424a883abdde5ea6689097f636f336315254416194799ec556bf8ff30eaa75e2
MD5 699488049236b5d745ec99254babf52d
BLAKE2b-256 6f13e60dad8e82e8bd8f042c2cf13e1b3f26f276027b7060af4f03948207ddf7

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp313-cp313-win_amd64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp313-cp313-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp313-cp313-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 71cc1c9cf3ae5d54c66c9b1b788bad28bfdfb207c2fae251b3b322915df62082
MD5 78d6985ef2e67018b7f7bf64671e89e1
BLAKE2b-256 e4b49552b39784f37e7d326dd3048f78cf4f705fdf4466e7a602c8e2bfbbae03

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp313-cp313-manylinux_2_34_x86_64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 dc3f2bf608c50ae3a0ffe63b7fe679200442e903ad6979e8e957fe77984f940f
MD5 d3cf94b5d514168b010b56e644290ec2
BLAKE2b-256 8c144e51145b7c7342ef60b1cb8e21309bfae08da07020908b287416f367a47f

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp313-cp313-macosx_11_0_arm64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp313-cp313-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp313-cp313-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 080986fe674f7d3b7a61938aebbd1576441e7692104b64b14ef3b48f8838af82
MD5 d98908a35b906133b68a5b3249f9f84c
BLAKE2b-256 f83e72b5ba46723b31deb6cd66724a9164f46e64093790997f5545d2d3e761cb

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp313-cp313-macosx_10_12_x86_64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: djust-0.9.6rc2-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 7.4 MB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for djust-0.9.6rc2-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 8f6b5127776daeca48ca6286a7ca38a5cf25dc962116e0a26a04d457ddc02708
MD5 330955dc81a2de0c7ee76444103bcc26
BLAKE2b-256 e3679e1bf00b87db6701300add0dd07c273a5c6eb08c6d89508dec222d8aff67

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp312-cp312-win_amd64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp312-cp312-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp312-cp312-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 567abb3d4736c483023745af51cf4eb815b6eaa901288d23b5ce2da0ad9e0c1e
MD5 24a32d2294bf94adc7efdf98bebe787d
BLAKE2b-256 ddcadc8ca31b29d9b0600c8f415370b28a5098a4699b51b19cc2b72b7d40c32d

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp312-cp312-manylinux_2_34_x86_64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 670129879e86e7ac5b1a5de30e57494531e27e25be4779c40f6b576f955f7ac5
MD5 8f8b17bce28c4ef533d43cf3c107a226
BLAKE2b-256 58a9b6269b86a34c290e9d980dabd21b2e9bfd7f1bd43068f130c48c65593008

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp312-cp312-macosx_11_0_arm64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp312-cp312-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp312-cp312-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 08a58bcab279c9820a0ca5c9dc6413cf5c1fdec0c71f978056216b1696fa7a32
MD5 65f802125e5b8bdc6e5357b2eaaa8cc3
BLAKE2b-256 413568d3d1d47d7be818092012e6ba319353ecb1716587f594432c7ed09a564e

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp312-cp312-macosx_10_12_x86_64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp311-cp311-win_amd64.whl.

File metadata

  • Download URL: djust-0.9.6rc2-cp311-cp311-win_amd64.whl
  • Upload date:
  • Size: 7.4 MB
  • Tags: CPython 3.11, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for djust-0.9.6rc2-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 84e47fb81ad19e985fa0b8e53d55b2457955b67566bf780a838a84b866032c40
MD5 f0c1153cf7e23850fec6d1f691c47a89
BLAKE2b-256 0a4c1401d197efc1fb11f3bbab3fd2224d1d4572fc0e4392322d1079ae631865

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp311-cp311-win_amd64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp311-cp311-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp311-cp311-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 d9ff462460cdb431cb721e9e0df8b68abd168f1fc2524a384f74b9fbff6de345
MD5 1d8f94152fd048037f1554228c9969da
BLAKE2b-256 118b77b7ba3492b077fbbf691c9e24bef2a491bf3aec7a9a10862a080c8c41c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp311-cp311-manylinux_2_34_x86_64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 da33dc7d1db2cb6e8cf46af7c04380d21061501c365f33dfdf1296069faf5bfa
MD5 794401431f5cde9a4e2bcb35fe8da443
BLAKE2b-256 90242ce1857ae0965ea91861d0ecb98bbf14c71caf8e7efd69250856a66258d5

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp311-cp311-macosx_11_0_arm64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp311-cp311-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 a45467560485203a6efd78d1c3867a02b79fb147cdfae036f34255aa6cabbe51
MD5 81343115822e697977388a0cdd8423bc
BLAKE2b-256 377440f73b6fa7868ec534e58f93a65563639c97b02277dfa54d7bce73e026db

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp311-cp311-macosx_10_12_x86_64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file djust-0.9.6rc2-cp310-cp310-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.6rc2-cp310-cp310-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 b96de541fa123f8899427e2370f41f9d2c89666b4b860f9dea01717a0c5464fb
MD5 c45ccda910ae4556ed3f447898e2ef25
BLAKE2b-256 c199763d90e1886156864d8003e5e266122510ed4d819e843d6b6246905822a0

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.6rc2-cp310-cp310-manylinux_2_34_x86_64.whl:

Publisher: release.yml on djust-org/djust

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page