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.4rc1.tar.gz (4.8 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.4rc1-cp314-cp314-win_amd64.whl (7.4 MB view details)

Uploaded CPython 3.14Windows x86-64

djust-0.9.4rc1-cp314-cp314-manylinux_2_34_x86_64.whl (7.3 MB view details)

Uploaded CPython 3.14manylinux: glibc 2.34+ x86-64

djust-0.9.4rc1-cp314-cp314-macosx_11_0_arm64.whl (7.1 MB view details)

Uploaded CPython 3.14macOS 11.0+ ARM64

djust-0.9.4rc1-cp314-cp314-macosx_10_12_x86_64.whl (7.2 MB view details)

Uploaded CPython 3.14macOS 10.12+ x86-64

djust-0.9.4rc1-cp313-cp313-win_amd64.whl (7.4 MB view details)

Uploaded CPython 3.13Windows x86-64

djust-0.9.4rc1-cp313-cp313-manylinux_2_34_x86_64.whl (7.3 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.34+ x86-64

djust-0.9.4rc1-cp313-cp313-macosx_11_0_arm64.whl (7.1 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

djust-0.9.4rc1-cp313-cp313-macosx_10_12_x86_64.whl (7.2 MB view details)

Uploaded CPython 3.13macOS 10.12+ x86-64

djust-0.9.4rc1-cp312-cp312-win_amd64.whl (7.4 MB view details)

Uploaded CPython 3.12Windows x86-64

djust-0.9.4rc1-cp312-cp312-manylinux_2_34_x86_64.whl (7.3 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.34+ x86-64

djust-0.9.4rc1-cp312-cp312-macosx_11_0_arm64.whl (7.1 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

djust-0.9.4rc1-cp312-cp312-macosx_10_12_x86_64.whl (7.2 MB view details)

Uploaded CPython 3.12macOS 10.12+ x86-64

djust-0.9.4rc1-cp311-cp311-win_amd64.whl (7.4 MB view details)

Uploaded CPython 3.11Windows x86-64

djust-0.9.4rc1-cp311-cp311-manylinux_2_34_x86_64.whl (7.3 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.34+ x86-64

djust-0.9.4rc1-cp311-cp311-macosx_11_0_arm64.whl (7.1 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

djust-0.9.4rc1-cp311-cp311-macosx_10_12_x86_64.whl (7.2 MB view details)

Uploaded CPython 3.11macOS 10.12+ x86-64

djust-0.9.4rc1-cp310-cp310-manylinux_2_34_x86_64.whl (7.3 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.34+ x86-64

File details

Details for the file djust-0.9.4rc1.tar.gz.

File metadata

  • Download URL: djust-0.9.4rc1.tar.gz
  • Upload date:
  • Size: 4.8 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.4rc1.tar.gz
Algorithm Hash digest
SHA256 a8fba2fb85face496b9008c80b45a7e419591f3d303043037eb9969ac7b0e604
MD5 dfd19f351a369ba439500a4a64062651
BLAKE2b-256 f5551d8b6b35b7beb7cae1d5ddd2e441676c20d69650aaef2ca4667c3f408250

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1.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.4rc1-cp314-cp314-win_amd64.whl.

File metadata

  • Download URL: djust-0.9.4rc1-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.4rc1-cp314-cp314-win_amd64.whl
Algorithm Hash digest
SHA256 cc8e05d804fddf3ea586ae91fd2358683ce35e3a71a798d416bacc06b7f0d768
MD5 081c7afaa1bf0e3223acffb2ce269f46
BLAKE2b-256 fa1f0d85bda788e8fcaaf28f09770f4fe82c5a015f44c76d2b1904062b28ff1d

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp314-cp314-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp314-cp314-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 8ba226802b97064bb1373f27e78a583e590026c8c77f1148cf15346f50f925cc
MD5 ff7aa126f1c37e4a9d92a1e71aa54c5c
BLAKE2b-256 85569ac4b5856f1aa070f981326245d577aae62389318730d685b16ba6d937c3

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp314-cp314-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp314-cp314-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 97b9ca3ae33b154f96ebdf4387b2f8c21aff372036b1ddda0b9a2ad71dc4a9f0
MD5 3e59fe75f6af4dce63e81305ba9def2d
BLAKE2b-256 c0116d36e40d44b7ff2d85324ec9424ce441a9f2919a3b738d4a71192e56a514

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp314-cp314-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp314-cp314-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 2ed8997e36f3abd176bcc6e9167adba4f7844a73521cf0e6ce744d71effda2b3
MD5 63271afb24827706813375e2d379f2c0
BLAKE2b-256 fd28e63235a13eb4de0025d9bafd29298665c25caef4c34ead733b58624dbbaa

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp313-cp313-win_amd64.whl.

File metadata

  • Download URL: djust-0.9.4rc1-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.4rc1-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 8f0504ff277358ee334355560198667e47165be0b2ce7030b32d8fe8fabc821f
MD5 5247ba9faa5185025e3c62aa0ea33479
BLAKE2b-256 34be67711793705ea48c3e48af91b2f6e8ded731393e2278bf23b084540d9110

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp313-cp313-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp313-cp313-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 50131151527df7315b40bcf578909f1755c5a911b66002543bc90968119d7aab
MD5 500f4ecfc256de33d08b74ea5ee39460
BLAKE2b-256 4ef064059f23dd3689ffa58c337ad1b9ac2e5f790e06a199e3b89ad174febc70

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c4f80ecd185d7a9cca1fb8921e26979a00ab938fe68182bd396ceee838314c38
MD5 ee7503f0febd02e25992599d12bb20da
BLAKE2b-256 0a511e819746c465c2a82c72d130486047905626eab3723043451b99d673e9d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp313-cp313-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp313-cp313-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 108f159795d7ab92bec6ac4001470ce4a66d440bf0f2d64db203bd202a305879
MD5 06ccea2eb083015b0712143caa1faac0
BLAKE2b-256 ebe1cad1a40411b34b46ecaae359b281fc42b5a130b6f6adb26103dfcd3bab59

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: djust-0.9.4rc1-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.4rc1-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 fcca81f90e09d4121e192ff1b07aa846142423ce69cab23324dc5042d50782c8
MD5 ab2026991846f151ccc1f75f042cf1f1
BLAKE2b-256 c4df86ade7bffb32a982d388cfcde9fb91f44c0f76adc6f513b0bde656beda55

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp312-cp312-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp312-cp312-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 0f18d47a486ab344d369028593bee5f8e371782894d4762a223d64d6b0b83443
MD5 163357dd5a8029b173d12fd38ea6feea
BLAKE2b-256 2b7928efc40a871f5efe21b7eb43c0b8ef538525f005ee7c60ea6a6a57409e32

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a091a681b1b6e0f20e24f53b037422d7e430ecd8bf680945143916bf47707164
MD5 8e6c0fff791f4e37fb1bd54cb64492de
BLAKE2b-256 97a8531a50759ea31414f03daa4c410bcbedf3b197837f6e3d5ccc9405dd794e

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp312-cp312-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp312-cp312-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 8375b0b938d0e582b92039a63cb1d09e6b7168fdba8ad8e518f8d6fd129f2ad5
MD5 da0f35f443fe03b1fc48c71f2cf44cea
BLAKE2b-256 8f2ebe2b932b7824f8f2fd72de3c95e71a4062c5e355000327f2cd9982b38aee

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp311-cp311-win_amd64.whl.

File metadata

  • Download URL: djust-0.9.4rc1-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.4rc1-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 f40f2ce39f3cf7d9b6c2f6955bdce1d2e4786987f0194ab5cf030054278e535e
MD5 c425cd360e91ee4875ae7c181f776939
BLAKE2b-256 f1513fe6731516a2267630ac3e9718c033cb41a9c04fa04171e544750ad92a6b

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp311-cp311-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp311-cp311-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 89d2580e1ecdc1e46449741afc6d83ce22b4ba1e519e0f30e734c6e369e29100
MD5 62f70ecf714e65a68f047b84f3cfb3b2
BLAKE2b-256 45150b680d2356a0d6e0151e8dc7f665edf7004ee959a9f892a0f6978550f801

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 18349d1aa1583534bf9cf0ef542609de5a3073d5f5c0e78357ae901c71e2f3cc
MD5 77fcc4e2c6e947c9c65d4b5c942565c3
BLAKE2b-256 fc2ae92b789ce6131f2a497ffc86b0a5d7294ed0d112edde0148956b156db287

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp311-cp311-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 4183dbeac4c81928b1b4f189874cbe9b006695a68f32c4ff66a8da8fcbb3d3c3
MD5 0e5292729e25d6fd02534fbcc2f9193c
BLAKE2b-256 bc94df65d7b69c823f49b84f16a22e453159220c048c4cf7f9dd7ea2f7c66539

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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.4rc1-cp310-cp310-manylinux_2_34_x86_64.whl.

File metadata

File hashes

Hashes for djust-0.9.4rc1-cp310-cp310-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 d83727c46a071a6b168f1e1c783e106ec803330ded3409cda0678f75f6603c59
MD5 d50bf208793bc2a291d9630379fbaa73
BLAKE2b-256 0f0a6af5b8f1742a0d0c90c89d80cdc3c4b7cb6f3b840587e78433b799cb4f1c

See more details on using hashes here.

Provenance

The following attestation bundles were made for djust-0.9.4rc1-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