Skip to main content

Tests codecov PyPI version Python versions License: MIT Downloads Awesome Django

Django Control Room

Django Control Room

A framework for building Django admin tools, with a centralized dashboard to manage them


Django Control Room is a plugin framework for building Django admin tools (called "panels"), it's also a suite of official panels for managing all sorts of services like Redis, Celery, Caches and inspecting Django internals like URLs and Signals. Every panel - official or third-party - is a small, independent Python package built on the same public plugin API/SDK available in dj-control-room-base.

Install dj-control-room and it discovers every compatible panel via Python entry points, renders it in a centralized dashboard, and gives it a shared design system, permissions model, and admin sidebar integration - all for free.

The Official Panels below are reference implementations of that same framework - a starting point, not the whole story. See Creating Custom Panels to build your own.

Features

  • Plugin Framework - Build your own admin tools with the core libs in dj-control-room-base; your panels behave exactly like the official ones
  • Centralized Dashboard - Every installed panel, official or custom, is discovered automatically and displayed in one place
  • Beautiful UI - Modern, responsive design with dark mode support, shared across every panel via a common design system
  • Secure - Package verification prevents panel hijacking
  • Easy Integration - Works seamlessly with Django admin
  • Official Panels - Pre-built panels for common tasks, built on the same framework available to you
  • django-unfold theme adapter - opt-in stylesheet that remaps colors to match django-unfold's accent/neutral palette (see Theme adapters)
  • AI Agent Integration (MCP) - a single MCP endpoint aggregates every installed panel's tools for AI agents (Cursor, Claude, etc.), so agents only need to configure one server for your whole admin toolset (see Configuration)

Django Control Room Dashboard

django-unfold Theme

When running under django-unfold, enable the bundled unfold.css theme adapter via EXTRA_CSS to match the dashboard's colors to the host site's accent and neutral palette. This is opt-in - it is not applied automatically just because django-unfold is installed.

DJ_CONTROL_ROOM_SETTINGS = {
    'EXTRA_CSS': ['dj_control_room_base/css/themes/unfold.css'],
}

Django Control Room Dashboard with django-unfold theme

django-jazzmin Theme

When running under django-jazzmin, enable the bundled jazzmin.css theme adapter via EXTRA_CSS to match the dashboard's colors to whichever Bootstrap/Bootswatch palette Jazzmin is configured with. This is opt-in - it is not applied automatically just because django-jazzmin is installed.

DJ_CONTROL_ROOM_SETTINGS = {
    'EXTRA_CSS': ['dj_control_room_base/css/themes/jazzmin.css'],
}

Django Control Room Dashboard with django-jazzmin theme

Installation

# Core only
pip install dj-control-room

# With specific official panels
pip install dj-control-room[redis,cache,urls]

# Or with all official panels
pip install dj-control-room[all]

Add dj_control_room_base (core library), your panels, then dj_control_room (so they all appear under one admin section), include the URLs, and migrate:

INSTALLED_APPS = [
    # ...
    'dj_control_room_base',
    'dj_redis_panel',
    'dj_cache_panel',
    'dj_urls_panel',
    'dj_control_room',
]
urlpatterns = [
    path('admin/dj-redis-panel/', include('dj_redis_panel.urls')),
    path('admin/dj-cache-panel/', include('dj_cache_panel.urls')),
    path('admin/dj-urls-panel/', include('dj_urls_panel.urls')),
    path('admin/dj-control-room/', include('dj_control_room.urls')),
    path('admin/', admin.site.urls),
]
python manage.py migrate

Then visit http://localhost:8000/admin/dj-control-room/.

For the full walkthrough and settings reference (admin sidebar behavior, theme adapters, MCP/AI agent integration), see the Installation and Configuration docs.

Admin Sidebar Integration

All installed panels appear in the Django admin sidebar under "Django Control Room":

Admin Sidebar

Control Sidebar Behavior (Optional)

# settings.py
DJ_CONTROL_ROOM_SETTINGS = {
    # Global: Show panels in both Control Room and their own sections
    'REGISTER_PANELS_IN_ADMIN': False,  # Default: False

    # Per-panel: Override for specific panels
    'PANEL_ADMIN_REGISTRATION': {
        'dj_redis_panel': True,   # Redis in both places
        'dj_cache_panel': False,  # Cache only in Control Room
    },

    # CSS: load built-in styles and/or inject your own
    'LOAD_DEFAULT_CSS': True,
    # Static paths are relative to app's static/ dir (e.g. 'myapp/css/overrides.css'
    # for a file at myapp/static/myapp/css/overrides.css). Full URLs also accepted.
    'EXTRA_CSS': [],
}

Official Panels

These are reference panels built using the same plugin framework described above - a great way to see it in action, and a starting point if you want to build your own.

Official Panels

Available Now

Panel Description Install
Redis Panel Monitor connections, inspect keys, view memory usage pip install dj-redis-panel
Cache Panel Inspect cache entries, view hit/miss ratios pip install dj-cache-panel
URLs Panel Browse URL patterns, test resolvers pip install dj-urls-panel
Celery Panel Monitor workers, track task queues pip install dj-celery-panel
Signals Panel Inspect Django signals and recievers pip install dj-signals-panel

Coming Soon

Panel Description Status
Error Panel Monitor errors, exceptions, and tracebacks In Development

Creating Custom Panels

The fastest way to create a new panel is using our official cookiecutter template:

pip install cookiecutter
cookiecutter https://github.com/django-control-room/cookiecutter-dj-control-room-plugin

This generates a complete panel structure with Django admin integration, tests, documentation, and Docker setup.

Manual Panel Creation

Prefer full control over the generated structure? You can build a panel by hand instead of using the cookiecutter template. See our Creating Panels Doc for the complete guide, or use our Build your own panel guide, which still uses the cookiecutter template to get started quickly.

Security

Django Control Room includes built-in security features:

  • Package Verification - Featured panels are verified by package origin
  • Staff-Only Access - Requires Django staff/superuser permissions
  • No Malicious Hijacking - Prevents panels from impersonating official packages

Documentation

Visit the official site at djangocontrolroom.com for guides, tutorials, and examples.

Full documentation: https://django-control-room.github.io/dj-control-room/

Requirements

  • Python 3.9+
  • Django 4.2+

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits

Created by Yasser Toruno


Official SiteStar us on GitHubReport BugRequest Feature

Download files

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

Source Distribution

dj_control_room-1.5.0.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

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

dj_control_room-1.5.0-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file dj_control_room-1.5.0.tar.gz.

File metadata

  • Download URL: dj_control_room-1.5.0.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for dj_control_room-1.5.0.tar.gz
Algorithm Hash digest
SHA256 ef817a94aec4cd09ab16a27db7140236044b88af092841eb7f653061e9db137a
MD5 bd320563ee4193d78ca0de848bb7569f
BLAKE2b-256 f9f6dc699cfe1235a9cf22597fb0c5f77ac23f05fe876d957988e06a1b8b6b12

See more details on using hashes here.

Provenance

The following attestation bundles were made for dj_control_room-1.5.0.tar.gz:

Publisher: python-publish.yml on django-control-room/dj-control-room

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dj_control_room-1.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dj_control_room-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30ca8113f41bcc547bb813e2f565838f36999cdb9c9b3c54d2a8c9548a94d3e0
MD5 e8fa9e9377e31d45064a2fc94a3e303f
BLAKE2b-256 0f4a8df2b124562f614d416a5e53db33d5e7c51b7af21128e14df0702d33a91f

See more details on using hashes here.

Provenance

The following attestation bundles were made for dj_control_room-1.5.0-py3-none-any.whl:

Publisher: python-publish.yml on django-control-room/dj-control-room

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.7.1

2 files

1.7.0

2 files

1.6.0

2 files

This release

1.5.0 This release

2 files

1.4.0

2 files

1.3.1

2 files

1.3.0

2 files

1.2.0

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.1

2 files

1.0.0

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page