Django Control Room Panel Tests codecov PyPI version Python versions Downloads License: MIT

dj-control-room-base

dj-control-room-base - a core library for creating DCR panels

dj-control-room-base is a core library for Django Control Room panels. It provides the shared primitives that every panel needs: settings management, CSS injection, permission enforcement, admin sidebar integration, template context helpers, and MCP-style panel tools.

Official Django Control Room panels ship with this package as a dependency and build on these APIs rather than reimplementing them panel by panel.

Optionally, the package can also be mounted as a full panel in its own right: it ships a bundled design system reference UI and example patterns that are useful when building or theming new panels.

What this library provides

  • Centralized CSS and permissions - a single PanelConfig object per panel drives CSS injection, staff/group/superuser checks, and settings merging across built-in, panel, hub, and project layers.
  • Admin sidebar integration - PanelPlaceholderModel and BasePanelAdmin give any panel a sidebar entry with no extra migrations.
  • Template context helpers - panel_config.get_context(request, ...) returns a ready-to-use context with CSS and Django admin variables included.
  • Entry-point discovery - panels register with the hub via a PanelPlugin subclass and a pyproject.toml entry point.
  • Panel tools - optional, permission-scoped callables the dj-control-room hub aggregates for AI agent and in-admin chat integrations.
  • Theme adapters - opt-in stylesheets that match panels to django-unfold, django-jazzmin, or django-grappelli.

See the full documentation for configuration options and a guide to building your own panel on this library.

Requirements

  • Python 3.9+
  • Django 4.2+ (tested in CI across Django 4.2, 5.2, and 6.0)

Quick start

pip install dj-control-room-base

# settings.py
INSTALLED_APPS = [
    ...
    "dj_control_room_base",
]

# urls.py
urlpatterns = [
    path("admin/dj-control-room-base/", include("dj_control_room_base.urls")),
    path("admin/", admin.site.urls),
]

python manage.py migrate
python manage.py runserver

Open /admin/ and sign in. A DJ CONTROL ROOM BASE entry appears in the sidebar and links to the panel at /admin/dj-control-room-base/.

See Installation for the complete walkthrough, Configuration for CSS/permission settings and theme adapters, and Building Panels for a guide to building your own panel on this library.

Development

git clone https://github.com/django-control-room/dj-control-room-base.git
cd dj-control-room-base
make install
make test_local

See Development for Docker setup, coverage, and the full Makefile reference.

License

MIT. See LICENSE.

Project links

Data verified by PyPI on Jul 31, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.5.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for yassi from gravatar.com yassi

Credits

Author/Maintainer: Yasser Toruno

GitHub Statistics

Data verified by PyPI on Jul 31, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT License (MIT)

Requires

Python >=3.9

Provides Extra

dev build

Tags

django admin panel

Classifiers

Report project as malware

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_base-1.4.0.tar.gz (136.0 kB 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_base-1.4.0-py3-none-any.whl (147.3 kB view details)

Uploaded Python 3

File details

Details for the file dj_control_room_base-1.4.0.tar.gz.

File metadata

  • Download URL: dj_control_room_base-1.4.0.tar.gz
  • Upload date:
  • Size: 136.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dj_control_room_base-1.4.0.tar.gz
Algorithm Hash digest
SHA256 475b0086fed12c45e0e9fb9538d27030665c6d3d56a4a1f1ba9d00b2637e295d
MD5 278b3dfb347a815466feeea9a2775429
BLAKE2b-256 e3cf4b9ffa280c11187c7e96de6dc83875552a6d69f536ae8a7a72426271c26d

See more details on using hashes here.

Provenance

The following attestation bundles were made for dj_control_room_base-1.4.0.tar.gz:

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

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_base-1.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dj_control_room_base-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 719b6f283faba6d7347137c9b922154ebfb89d97310f0c9ff4c2cefdd07f257f
MD5 9779cebd24460f9d833541c4db2a9ba4
BLAKE2b-256 227ab8cfd2998faae8bfa83faadb20a9376e35d1d10ee6c83cc45e63d97d4e12

See more details on using hashes here.

Provenance

The following attestation bundles were made for dj_control_room_base-1.4.0-py3-none-any.whl:

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

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page