django-lux 1.2.14

DjangoLux - A modern UX/UI framework for Django: a themeable, multilingual design system plus batteries-included app infrastructure (auth, CRUD, audit, navigation).

DjangoLux — A Modern UX/UI Framework for Django

Open DjangoLux Agent on ChatGPT
_{Specialized custom GPT for django-lux integration, configuration, extension, and troubleshooting.}

DjangoLux is an extensive UX/UI framework for Django — a complete, design-first playground for building modern web apps. It ships a polished, themeable design system on top of Bootstrap 5 (multiple built-in themes, full RTL/LTR + multilingual support, custom font management, and theme/language/direction-aware components) and pairs it with the batteries a real application needs: a first-launch setup wizard, user management and security, scopes, navigation, activity logging, guided onboarding, data export, and zero-boilerplate CRUD tooling.

Think of it as a cohesive foundation rather than a themed admin shell — instead of assembling auth, theming, tables, forms, navigation, and auditing yourself, you get them wired together and configurable at runtime, so you can focus on your app's actual features. The package keeps the landing README short; long-form operating and integration guidance lives at docs/.

What DjangoLux gives you

• A complete, themeable design system on Bootstrap 5: multiple built-in themes with a shared theme registry, full RTL/LTR and multilingual rendering, custom font management, responsive layouts, reusable components (tables, forms, modals, selectors, sidebar, navbar, tutorials), and theme/language/direction-aware surfaces — all driven by a single dlux token vocabulary.
• A first-launch setup wizard at /sys/setup/ for identity, explicit language catalog management, translation-matrix overrides, access/security toggles, UI-first Dlux email delivery, themes, default table density, global home URL, and sidebar structure, including full sidebar disable, runtime sidebar-toolbar, and user-reordering controls.
• A runtime system UI for users and superusers, including Options, user management, profiles, 2FA, activity logs, scopes, and system settings.
• A disabled-by-default public registration playground for email-first local signup with mandatory email verification, Dlux email readiness checks, public-account provenance badges, throttles, and optional approval.
• A database-backed SystemSettings singleton layered over DLUX_CONFIG, so projects can seed defaults in code and refine them in the UI later.
• A framework-owned django_tables2 platform that auto-adopts stock tables, ships built-in pagination and per-page controls, exposes a public DluxTable base class, and supports per-table dlux_table, dlux_density, dlux_per_page, and dlux_actions overrides.
• A ScopedModel base with audit fields, soft-delete behavior, actor tracking, filtered managers, and automatic scope handling.
• Zero-boilerplate sections and dynamic modal CRUD flows for auxiliary models, plus a reusable context-menu/event model for richer interactions.
• A built-in audit trail with signal-based logging, merged User/Profile updates, diff capture, masked sensitive fields, and download/export log entries.
• Universal data helpers such as fetch_file, fetch_excel, sticky-form autofill, tutorial overlays, and persistent UI preferences.

Requirements

The runtime dependencies below are installed automatically with django-lux.

• Python 3.11+
• Django 5.1+
• django-crispy-forms
• crispy-bootstrap5
• django-tables2
• django-filter
• pillow "for image handling"
• babel "for translations"
• psutil "for system monitoring"
• pyotp "for TOTP 2FA"
• qrcode "for TOTP 2FA QR codes"
• cryptography "for encrypted TOTP and SMTP secret storage"
• openpyxl "for XLSX exports"
• packaging "for version and requirement validation"

Generated Compose projects install the optional django-lux[updater] extra for PyPI provenance verification. Manual and non-Compose installs do not need that extra unless they deliberately adopt the generated updater architecture.

Installation

pip install django-lux
# OR
pip install git+https://github.com/debeski/django-lux.git

Scaffold a New Project or App

python -m dlux startproject myproject
cd myproject
python -m dlux startapp billing --register

python -m dlux startproject creates a new Django project already wired for DjangoLux. python -m dlux startapp creates a DjangoLux-native app skeleton with models, forms, filters, tables, translations, templates, tests, and optional project registration.

Generated projects also include a baseline Docker stack with compose.yml, compose.dev.yml, a config/celery.py worker entrypoint, a /health/ endpoint via django-health-check, and the verified dlux-updater service with its persistent runtime volume and nginx maintenance fallback. They also generate .secrets/.env with the bootstrap secrets used by the standard decrypter/startup flow. The scaffolded settings baseline now also includes django-cors-headers and django-csp with their apps, middleware, and starter CORS/CSP policy settings.

Inline updates are enabled only by the recognized generated Compose baseline. Other installations keep DLUX_INLINE_UPDATES_ENABLED=False unless they are explicitly migrated with the guarded bootstrap described in the Verified Inline Updater guide.

Minimal Quick Start

1. Add the DjangoLux helper at the end of your project settings.py.

from dlux.utils import dlux_settings

dlux_settings(globals())

That helper prepends the required apps, inserts django.middleware.locale.LocaleMiddleware and dlux.middleware.DluxMiddleware in the supported order, adds the Dlux context processor, sets the Crispy Bootstrap 5 defaults, adds a Bootstrap-friendly MESSAGE_TAGS error mapping, and seeds the standard DjangoLux runtime defaults for language, timezone, i18n/tz flags, FORMAT_MODULE_PATH, and charset unless your project already defines them.

Proceed to Getting Started if you prefer to wire everything manually.

Public registration is documented separately at Public Registration Playground. It is disabled by default and is not part of the optional SSO packages.

2. Mount dlux.urls at project root so the bundled auth and system routes stay at /accounts/... and /sys/....

from django.urls import include, path

urlpatterns = [
    path("", include("dlux.urls")),
]

With that root include in place, dlux provides /accounts/... and /sys/.... If your project does not define its own / view, dlux falls back from an unresolved / request into its login/setup flow instead of leaving a 404. On a fresh and unconfigured install, Dlux also guards ordinary anonymous requests so a public root page cannot bypass first-time setup; once setup is complete, your existing root view continues to behave normally.

3. Run the setup command.

python manage.py dlux_setup

4. Sign in as a superuser and complete the first-launch wizard at /sys/setup/. On a fresh install, an anonymous request may be sent through /sys/setup/ and then to login before the wizard can be completed. After setup, the main runtime UI lives under user_hub.

For a fuller setup path, prefix-mount guidance, and first-launch expectations, use the Getting Started guide.

Key Capabilities

• Onboarding and runtime configuration: first-launch setup wizard, Options view, runtime System Settings modal, source-tabbed translation overrides, setup import/export, language/theme defaults, and a global Home destination.
• User and security operations: interactive user wizard, grouped translated permissions, four-tier staff authorization (superuser, Global Staff, Central Staff, Scoped Staff), permission-based sidebar visibility, profile management, multiple 2FA flows (App, Email, Backup), trusted device tracking for 30 days, and runtime preference persistence.
• Generic CRUD infrastructure: dynamic sections, AJAX-driven modal CRUD, automatic form/table/filter discovery, context-menu actions, and reusable event dispatch.
• Navigation and UI infrastructure: resolver-driven sidebar builder with permission-based visibility, runtime tree rendering, optional user-level reordering, configurable sidebar toolbar visibility, a shared theme registry, tutorial overlays, theme-aware system surfaces, and template injection hooks.
• Data movement and productivity helpers: universal file download, Excel export, smart autofill, sticky-form cloning, and generic list/filter helpers.
• Audit and governance: signal-based activity logging with configurable IP resolution (direct/proxy/header), diff capture, masked sensitive fields, deduplicated entries, download/export logging, and scoped visibility.
• Optional SSO: django-lux-sso and django-lux-sso-client live as separate optional packages for OIDC provider/client deployments without changing core Dlux runtime behavior.
• Standalone backup viewer: tools/dlb-viewer/ is a dependency-free, cross-platform binary for inspecting encrypted .dlb system backups offline — browse models, rows, and stored files without a running instance. Prebuilt binaries ship with each release.
• Full-system backup policy: superusers can configure scheduled encrypted backups, storage-relative export targets, and age/count rotation from System Settings; inline updates and rollbacks require a verified pre-maintenance backup.
• Framework-level automation: translation patches, scoped-model auto-injection, actor tracking, soft-delete, and config layering across defaults, project settings, and runtime UI.
• Verified generated-Compose updates: daily stable-release checks, superuser-approved staged updates, maintenance/backup handling, process generation restarts, and compatible code/static rollback without rebuilding the project image.

Documentation

• Documentation Hub
• Security Policy
• Contributing Guide
• Code of Conduct
• Getting Started
• Admin Guide
• Developer Guide
• Customization Guide
• Reference
• DSRP-1 Security Standard
• Optional SSO Packages
• Standalone .dlb Backup Viewer
• Verified Inline Updater
• Releasing — tag-driven PyPI + GitHub release flow
• Migrating from django-microsys — in-place upgrade for existing deployments
• Features — complete feature inventory
• Changelog