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. One command, shared cookies, native Reflex dev.

PyPI Python Docs License

Documentation · LLM guide · GitHub · PyPI


What is reflex-django?

reflex-django is a Reflex plugin that runs your Django project and Reflex UI together. You keep Django for models, admin, auth, and APIs. You build the frontend in Python with Reflex components and state.

One dev command (reflex run) starts both sides. Sessions and cookies are shared, so a user logged in through Django is logged in on Reflex pages. Event handlers on Django-aware state read self.request.user like a Django view when bridge is enabled and the resolved tier binds request context.

The plugin wires four pieces automatically (embed, mount, proxy, bridge). Set profile: "integrated" in rxconfig.py and you get port 3000 dev, SPA routing, and Django middleware on bridge-bound Reflex events.

Install

uv add reflex-django

Or with pip (you also need Django and Reflex):

pip install reflex-django django reflex

New project with uv:

uv add django reflex reflex-django

Quick start

rxconfig.py:

import reflex as rx
from reflex_django.plugins import ReflexDjangoPlugin

config = rx.Config(
    app_name="shop",
    plugins=[
        ReflexDjangoPlugin(config={
            "settings_module": "config.settings",
            "profile": "integrated",
        }),
    ],
)

Then:

  1. Add reflex_django to INSTALLED_APPS and put AsyncStreamingMiddleware last in MIDDLEWARE (full setup)
  2. Create shop/shop.py with app = rx.App() and app.add_page(...) (pages and state)
  3. Run reflex django migrate and reflex run
  4. Open http://localhost:3000/

Learn each integration piece step by step →

API guides: Serializers · Model state · Forms/FieldSpec · Live updates · Devtools · Auth · Security · Config


Commands

reflex run
reflex export
reflex django migrate
reflex django makemigrations
reflex django createsuperuser
reflex django scaffold shop.Product --output shop/product_views.py

Requirements

Version
reflex-django 4.0+
Python 3.12+
Django 6.0+
Reflex >=0.9.4,<1.0

Author: Mohannad Irshedat · 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-4.0.3.tar.gz (249.7 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-4.0.3-py3-none-any.whl (246.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: reflex_django-4.0.3.tar.gz
  • Upload date:
  • Size: 249.7 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-4.0.3.tar.gz
Algorithm Hash digest
SHA256 4fe6d5dfcce576baefaa56917bbbe9e13ab497b182b6beae2a12218409d316d0
MD5 18e8f659cc2cba3024511b30121aafa9
BLAKE2b-256 51594ddb69f4bfc5eab78e4c54ee57c79cf33d718d03164ec6bc8cd9b8111412

See more details on using hashes here.

File details

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

File metadata

  • Download URL: reflex_django-4.0.3-py3-none-any.whl
  • Upload date:
  • Size: 246.9 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-4.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3e86a7bfde6a5ad5e5be64b1acb98bddcd8f8cc53bd40dc979dd08159d913c1c
MD5 646a7a5348b152e7239bb5d04911772c
BLAKE2b-256 1c325d07f1aa41d1b0f2de9307f8f814c71a33a3cc545fd2a6f808f07e1d88a1

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