Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dizballanze/django-admin-env-notice
Visually distinguish environments in Django Admin
https://github.com/dizballanze/django-admin-env-notice
django django-admin django-admin-panel python
Last synced: 7 days ago
JSON representation
Visually distinguish environments in Django Admin
- Host: GitHub
- URL: https://github.com/dizballanze/django-admin-env-notice
- Owner: dizballanze
- License: mit
- Created: 2017-06-20T12:02:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-19T11:59:39.000Z (20 days ago)
- Last Synced: 2024-10-19T16:38:45.644Z (20 days ago)
- Topics: django, django-admin, django-admin-panel, python
- Language: Python
- Size: 219 KB
- Stars: 316
- Watchers: 14
- Forks: 22
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Authors: AUTHORS.rst
Awesome Lists containing this project
- awesome-django-admin - django-admin-env-notice - Visually distinguish environments in Django Admin (Packages to install at your project / Packages)
- -awesome-django - django-admin-env-notice - Visually distinguish environments in Django Admin, for example: `development`, `staging`, `production`. (Third-Party Packages / Admin)
- awesome-django - django-admin-env-notice - Visually distinguish environments in Django Admin, for example: `development`, `staging`, `production`. (Third-Party Packages / Admin)
- awesome-django - django-admin-env-notice - Visually distinguish environments in Django Admin, for example: `development`, `staging`, `production`, ... etc. (Admin interface)
README
# django-admin-env-notice
[](https://badge.fury.io/py/django-admin-env-notice)
[](https://travis-ci.org/dizballanze/django-admin-env-notice)
[](https://codecov.io/gh/dizballanze/django-admin-env-notice)
Visually distinguish environments in Django Admin. Based on great advice from post: [5 ways to make Django Admin safer](https://hackernoon.com/5-ways-to-make-django-admin-safer-eb7753698ac8) by [hakibenita](https://hackernoon.com/@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`:
```python
INSTALLED_APPS = (
...
'django_admin_env_notice',
'django.contrib.admin',
...
)
```
Add context processor:
```python
TEMPLATES = [
{
...
"OPTIONS": {
"context_processors": [
...
"django_admin_env_notice.context_processors.from_settings",
],
},
},
]
```
Set label and color for current environment:
```python
ENVIRONMENT_NAME = "Production server"
ENVIRONMENT_COLOR = "#FF2222"
```
Override django admin selector if necessary (default: body), e.g: grappelli:
```python
ENVIRONMENT_ADMIN_SELECTOR = "grp-header"
```
Optionally, set the environment banner to float over instead of being fixed to the top:
```python
ENVIRONMENT_FLOAT = True
```
You can also set the text color (default: white) by setting:
```python
ENVIRONMENT_TEXT_COLOR = "#00FF00"
```
You can stop showing the banner to unauthenticated users by setting (default: `True`):
```python
ENVIRONMENT_SHOW_TO_UNAUTHENTICATED = False
```
## Screenshots
## Running Tests
Does the code actually work?
```
source /bin/activate
(myenv) $ pip install tox
(myenv) $ tox
```
## Credits
Tools used in rendering this package:
- [Cookiecutter](https://github.com/audreyr/cookiecutter)
- [cookiecutter-djangopackage](https://github.com/pydanny/cookiecutter-djangopackage)