# 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 <YOURVIRTUALENV>/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)
Raw data
{
"_id": null,
"home_page": "https://github.com/dizballanze/django-admin-env-notice",
"name": "django-admin-env-notice",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "django-admin-env-notice",
"author": "Iurii Shikanov",
"author_email": "dizballanze@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/51/d9/38724a1196c2e42431ff3cb6d08ff2e790ff3d236d4065ccb59df141b419/django-admin-env-notice-1.0.1.tar.gz",
"platform": null,
"description": "# django-admin-env-notice\n\n[](https://badge.fury.io/py/django-admin-env-notice)\n[](https://travis-ci.org/dizballanze/django-admin-env-notice)\n[](https://codecov.io/gh/dizballanze/django-admin-env-notice)\n\nVisually 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).\n\n## Requirements\n\n- Python 2.7, 3.4+\n- Django 1.9+\n\n\n## Quickstart\n\nInstall django-admin-env-notice::\n\n```\npip install django-admin-env-notice\n```\n\nAdd it to your `INSTALLED_APPS` before `django.contrib.admin`:\n\n```python\n\nINSTALLED_APPS = (\n ...\n 'django_admin_env_notice',\n 'django.contrib.admin',\n ...\n)\n```\n\nAdd context processor:\n\n```python\n\nTEMPLATES = [\n {\n ...\n \"OPTIONS\": {\n \"context_processors\": [\n ...\n \"django_admin_env_notice.context_processors.from_settings\",\n ],\n },\n },\n]\n```\n\nSet label and color for current environment:\n\n```python\nENVIRONMENT_NAME = \"Production server\"\nENVIRONMENT_COLOR = \"#FF2222\"\n```\n\nOverride django admin selector if necessary (default: body), e.g: grappelli:\n\n```python\nENVIRONMENT_ADMIN_SELECTOR = \"grp-header\"\n```\n\nOptionally, set the environment banner to float over instead of being fixed to the top:\n\n```python\nENVIRONMENT_FLOAT = True\n```\n\nYou can also set the text color (default: white) by setting:\n```python\nENVIRONMENT_TEXT_COLOR = \"#00FF00\"\n```\n\nYou can stop showing the banner to unauthenticated users by setting (default: `True`):\n \n```python\nENVIRONMENT_SHOW_TO_UNAUTHENTICATED = False\n```\n\n## Screenshots\n\n\n\n\n\n## Running Tests\n\nDoes the code actually work?\n\n```\nsource <YOURVIRTUALENV>/bin/activate\n(myenv) $ pip install tox\n(myenv) $ tox\n```\n\n## Credits\n\nTools used in rendering this package:\n\n- [Cookiecutter](https://github.com/audreyr/cookiecutter)\n- [cookiecutter-djangopackage](https://github.com/pydanny/cookiecutter-djangopackage)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Visually distinguish environments in Django Admin",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/dizballanze/django-admin-env-notice"
},
"split_keywords": [
"django-admin-env-notice"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9fab7cbc300a966ecd3b272448a50952340038294b938ff67a0fb3dacfecc68a",
"md5": "d9d61a83e679682af65f3556cde20ada",
"sha256": "353903ff22b6a483313b6f12fa94a77dca397861729ed1ba257e3ec0659ecb45"
},
"downloads": -1,
"filename": "django_admin_env_notice-1.0.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d9d61a83e679682af65f3556cde20ada",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 5759,
"upload_time": "2024-10-19T12:10:03",
"upload_time_iso_8601": "2024-10-19T12:10:03.286430Z",
"url": "https://files.pythonhosted.org/packages/9f/ab/7cbc300a966ecd3b272448a50952340038294b938ff67a0fb3dacfecc68a/django_admin_env_notice-1.0.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "51d938724a1196c2e42431ff3cb6d08ff2e790ff3d236d4065ccb59df141b419",
"md5": "e015b4e65800f898a4892c5564af33fe",
"sha256": "1fc8da895b034f24a0c49d8170397aa8fd00db9eed63d3856cbbc2add6ed4d58"
},
"downloads": -1,
"filename": "django-admin-env-notice-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "e015b4e65800f898a4892c5564af33fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4984,
"upload_time": "2024-10-19T12:10:04",
"upload_time_iso_8601": "2024-10-19T12:10:04.624680Z",
"url": "https://files.pythonhosted.org/packages/51/d9/38724a1196c2e42431ff3cb6d08ff2e790ff3d236d4065ccb59df141b419/django-admin-env-notice-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-19 12:10:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dizballanze",
"github_project": "django-admin-env-notice",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"requirements": [],
"tox": true,
"lcname": "django-admin-env-notice"
}
JSON
