Skip to main content

Show a floating notice banner above the Django admin interface

Project description

Django Admin Notice

PyPI PyPI - License

Show a floating notice banner above the Django admin interface. Particularly useful for indicating the current deployment environment.


Install django-admin-notice via the Python Package Index (PyPI):

pip install django-admin-notice

Add admin_notice to your INSTALLED_APPS somewhere before django.contrib.admin.

# yourproject/
    # ... other apps
    "admin_notice",  # <-- Add this somewhere before "django.contrib.admin"
    # ... other apps

Add admin_notice.context_processors.notice to the templates context_processors.

# yourproject/
        "OPTIONS": {
            "context_processors": [
                # ... other context processors
                "admin_notice.context_processors.notice",  # <-- Add this
                # ... other context processors


Set the ADMIN_NOTICE_TEXT to the text you want to show above the admin interface. No message is shown if this setting is missing or empty.

# yourproject/
ADMIN_NOTICE_TEXT = "Production environment"

Optionally specify a custom text color and background for your notice. The default text color is white and the default background red.

# yourproject/


It's a common use case to indicate the projects deployment environment. The following configuration shows how to obtain the django-admin-notice configuration from environment variables and how to configure a fallback.

# project/
from os import environ

ADMIN_NOTICE_TEXT = environ.get("ADMIN_NOTICE_TEXT", "Local environment")


Run python runserver after following the Installation section to see a fully working example project.



  1. Clone the repository and enter the cloned folder
  2. (optional) Create and activate a dedicated Python virtual environment
  3. Run pip install -e ".[dev]" to install the projects requirements
  4. (optional) Run pre-commit install to install the pre-commit hook

Pre-commit hook

Our pre-commit hook formats and lints the code.

Formatting and linting

  • Run black admin_notice tests to format the code
  • Run flake8 admin_notice tests to lint the code


  • Run py.test --cov admin_notice tests to run the tests in the current Python env
  • Run tox to run the tests in all supported Python and Django environments


All commands listed above have shortcut make recipes. Take a look at the Makefile to learn more.

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

django-admin-notice-1.0.0.tar.gz (3.8 kB view hashes)

Uploaded Source

Built Distribution

django_admin_notice-1.0.0-py3-none-any.whl (4.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page