Skip to main content

Visually distinguish environments in Django Admin

Project description

django-admin-env-notice

Package Version Build Status Code Coverage

Visually distinguish environments in Django Admin. Based on great advice from post: 5 ways to make Django Admin safer by hakibenita.

Requirements

  • Python 2.7, 3.4+
  • Django 1.9+

Quickstart

Install django-admin-env-notice::

pip install django-admin-env-notice

Add it to your INSTALLED_APPS before django.contrib.admin:

INSTALLED_APPS = (
    ...
    'django_admin_env_notice',
    'django.contrib.admin',
    ...
)

Add context processor:

TEMPLATES = [
    {
        ...
        "OPTIONS": {
            "context_processors": [
                ...
                "django_admin_env_notice.context_processors.from_settings",
            ],
        },
    },
]

Set label and color for current environment:

ENVIRONMENT_NAME = "Production server"
ENVIRONMENT_COLOR = "#FF2222"

Override django admin selector if necessary (default: body), e.g: grappelli:

ENVIRONMENT_ADMIN_SELECTOR = "grp-header"

Optionally, set the environment banner to float over instead of being fixed to the top:

ENVIRONMENT_FLOAT = True

You can also set the text color (default: white) by setting:

ENVIRONMENT_TEXT_COLOR = "#00FF00"

You can stop showing the banner to unauthenticated users by setting (default: True):

ENVIRONMENT_SHOW_TO_UNAUTHENTICATED = False

Screenshots

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

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-env-notice-1.0.1.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

django_admin_env_notice-1.0.1-py2.py3-none-any.whl (5.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-admin-env-notice-1.0.1.tar.gz.

File metadata

File hashes

Hashes for django-admin-env-notice-1.0.1.tar.gz
Algorithm Hash digest
SHA256 1fc8da895b034f24a0c49d8170397aa8fd00db9eed63d3856cbbc2add6ed4d58
MD5 e015b4e65800f898a4892c5564af33fe
BLAKE2b-256 51d938724a1196c2e42431ff3cb6d08ff2e790ff3d236d4065ccb59df141b419

See more details on using hashes here.

File details

Details for the file django_admin_env_notice-1.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_admin_env_notice-1.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 353903ff22b6a483313b6f12fa94a77dca397861729ed1ba257e3ec0659ecb45
MD5 d9d61a83e679682af65f3556cde20ada
BLAKE2b-256 9fab7cbc300a966ecd3b272448a50952340038294b938ff67a0fb3dacfecc68a

See more details on using hashes here.

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