Skip to main content

Run a Django backend (Django ORM, Django Admin) alongside a Reflex app.

Project description

reflex-django

Keep Django. Get a reactive UI in Python. Same process, same port, same cookies.

PyPI Python Docs License

Documentation · GitHub · PyPI


What is it?

You love Django — the ORM, the admin, migrations, the way it just works. You also want a modern, reactive UI written in Python, not React.

reflex-django runs Django and Reflex as one ASGI app on one port. Configuration lives in urls.py. Pages live in views.py. The Django session you got from /admin/login/ is the same session your Reflex button handlers see.

  • Same port — Django at 8000, Reflex at 8000. No CORS, no token bridge, no second dev server.
  • Same cookies — log in once at /admin/, every Reflex event sees self.request.user.
  • Same middleware — your full settings.MIDDLEWARE chain runs on every Reflex event.
  • One commandpython manage.py run_reflex.

Minimal setup

Install:

uv add django reflex reflex-django

config/settings.py:

INSTALLED_APPS = [
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    "reflex_django",
    "shop",
]

MIDDLEWARE = [
    "django.middleware.security.SecurityMiddleware",
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.middleware.common.CommonMiddleware",
    "django.middleware.csrf.CsrfViewMiddleware",
    "django.contrib.auth.middleware.AuthenticationMiddleware",
    "django.contrib.messages.middleware.MessageMiddleware",
    "django.middleware.clickjacking.XFrameOptionsMiddleware",
    "reflex_django.streaming_middleware.AsyncStreamingMiddleware",
]

config/urls.py:

from django.contrib import admin
from django.urls import path
from reflex_django.urls import reflex_mount

urlpatterns = [path("admin/", admin.site.urls)]
urlpatterns += [
    reflex_mount(app_name="shop", django_prefix=("/admin",)),
]

config/asgi.py:

import os
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings")
from reflex_django.asgi_entry import application  # noqa: E402,F401

shop/views.py:

import reflex as rx
from reflex_django import template
from reflex_django.state import AppState


class HomeState(AppState):
    @rx.event
    async def on_load(self):
        user = self.request.user
        self.greeting = (
            f"Hi, {user.get_username()}!"
            if user.is_authenticated
            else "Hello, guest. Log in at /admin/."
        )


@template(route="/", title="Home", on_load=HomeState.on_load)
def index() -> rx.Component:
    return rx.vstack(
        rx.heading("My Shop"),
        rx.text(HomeState.greeting),
    )

Run:

python manage.py migrate
python manage.py run_reflex

Open http://localhost:8000/. Admin at http://localhost:8000/admin/.

That's it.


Why it exists

Reflex sends UI events over a WebSocket on /_event. Django middleware doesn't run on WebSockets. So request.user, sessions, messages, and CSRF aren't available inside @rx.event handlers by default — and the SPA usually wants its own port, which breaks cookie sharing.

reflex-django builds a synthetic HttpRequest for every event, runs your full settings.MIDDLEWARE chain on it, and binds self.request, self.user, self.session, self.messages, self.csrf_token onto your AppState handler. One process. One port. Same auth as your admin.

Full explanation: Why reflex-django exists.


Three files, three jobs

File What you configure
settings.py INSTALLED_APPS, MIDDLEWARE (incl. AsyncStreamingMiddleware), REFLEX_DJANGO_*
urls.py reflex_mount(app_name=..., django_prefix=..., rx_config={...})
{app}/views.py @template-decorated pages and AppState subclasses

No rxconfig.py. No {app}/{app}.py. No separate frontend.


Versions

Version
Python 3.12+
Django 6.0+
Reflex 0.9.2+

Documentation

The full docs walk you through the why, the how, and every knob:

Site: https://web7ai.github.io/reflex-django/


Common commands

python manage.py run_reflex            # dev server (auto-rebuild + watch)
python manage.py run_reflex --skip-rebuild   # faster reloads for pure Python edits
python manage.py export_reflex         # build the SPA bundle (for CI / deploy)
python manage.py migrate
python manage.py createsuperuser

Author: Mohannad Irshedat · GitHub · Docs

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reflex_django-0.4.2.tar.gz (208.5 kB view details)

Uploaded Source

Built Distribution

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

reflex_django-0.4.2-py3-none-any.whl (197.7 kB view details)

Uploaded Python 3

File details

Details for the file reflex_django-0.4.2.tar.gz.

File metadata

  • Download URL: reflex_django-0.4.2.tar.gz
  • Upload date:
  • Size: 208.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for reflex_django-0.4.2.tar.gz
Algorithm Hash digest
SHA256 8af8af4124562dd885e9e7d2fbe888a16c4994566d506cfb15a06a037003e2cd
MD5 41ee34f4f1f90806eba991274b7d4a54
BLAKE2b-256 b18c93e9d18c743d92ce0dce84e9c65fd3ff921862dd186d535da98ca3c15470

See more details on using hashes here.

File details

Details for the file reflex_django-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: reflex_django-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 197.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for reflex_django-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4503f94b3c61b12a296669d5f2478f4819075b17f33d9ec67fa20c8ff3b49c8a
MD5 2b25361d1e9dec57496365bb8eaea3a0
BLAKE2b-256 5a6b8fd2e25c229d0ba1fc4591235c35188c5dcb8d38e5a627583a27dacdae37

See more details on using hashes here.

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