Welcome to djxi

djxi is a Django library that eliminates the HTMX scattering problem: it bundles URL patterns, view logic, and HTML template sections for a feature into a single DXEndpointBattery class, keeping all related code in one place.

Getting Started

• Introduction
  • What is djxi?
  • Key concepts
  • Compatibility
• Installation and Setup
  • Requirements
  • Installation
  • INSTALLED_APPS
  • Middleware (recommended)
  • Base template
  • Running the included example
  • Notes
• Configuration
  • Runtime settings
  • Immutable constants
  • URL prefix resolution order
  • Template tags
  • Startup validation

User Guide

• Tutorial: Your first DXEndpointBattery
  • Prerequisites
  • Step 1 — Define the template sections
  • Step 2 — Create the battery class
  • Step 3 — Wire up the URLs
  • Step 4 — Add the list to a page template
  • Step 5 — Protecting endpoints (optional)
  • Step 6 — Verify routes
  • Further reading
• HTMX Middleware and Headers
  • Enabling the middleware
  • Reading request headers (request.htmx)
  • Setting response headers (response.htmx)
  • HTTP method override
  • Without middleware
• Permissions and Access Control
  • Quick start — requiring authentication
  • Redirecting to a login page
  • Fine-grained control with check_permissions()
  • How it works
  • Class attribute reference
  • Method reference
• Async Battery Support
  • Writing an async handler
  • Mixing sync and async handlers
  • arender_section()
  • Permission checks with async handlers
  • Requirements
  • Notes
• Testing Batteries
  • Overview
  • DXBatteryTestCase
  • DXRequestFactory
  • Standalone assertion helpers
  • Testing async handlers
  • Testing permission hooks
  • API reference
• Management Command: djxi_routes
  • Usage
  • Options
  • Discovery
  • Limitations

API Reference

• API Reference

Quick links

• Tutorial: Your first DXEndpointBattery — build your first battery step by step

• Permissions and Access Control — protect endpoints with requires_auth and check_permissions

• Async Battery Support — write async def battery handlers

• Testing Batteries — test batteries with DXBatteryTestCase

• Management Command: djxi_routes — list registered routes with djxi_routes