https://github.com/victorfsf/django-admin-colors

Customizable Django admin color themes
https://github.com/victorfsf/django-admin-colors

django django-admin django-admin-colors django-admin-themes python3

Last synced: 24 days ago
JSON representation

Customizable Django admin color themes

• Host: GitHub
• URL: https://github.com/victorfsf/django-admin-colors
• Owner: victorfsf
• License: mit
• Created: 2018-02-12T14:45:55.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-01-19T17:22:48.000Z (about 4 years ago)
• Last Synced: 2024-12-28T12:33:35.107Z (29 days ago)
• Topics: django, django-admin, django-admin-colors, django-admin-themes, python3
• Language: Python
• Size: 168 KB
• Stars: 35
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Django Admin Colors

[![PyPI version](https://badge.fury.io/py/django-admin-colors.svg)](https://badge.fury.io/py/django-admin-colors)

[![Build Status](https://circleci.com/gh/victorfsf/django-admin-colors/tree/master.svg?style=shield)](https://circleci.com/gh/victorfsf/django-admin-colors)

[![Coverage Status](https://coveralls.io/repos/github/victorfsf/django-admin-colors/badge.svg)](https://coveralls.io/github/victorfsf/django-admin-colors)

Customizing the Django Admin's CSS (mostly its colors)

## Installing

```bash

pip install django-admin-colors

```

## Configuring

The following instructions are necessary to make `django-admin-colors` work.

### Configure your `settings.py`

```python

INSTALLED_APPS = [

    ...,

    'admincolors'

]

# Choose a base theme

# If empty or not set, the first option of ADMIN_COLORS will be chosen

ADMIN_COLORS_BASE_THEME = 'Gray'

# These are the "builtin" django-admin-colors themes

ADMIN_COLORS = [

    ('Default', []),

    ('Lite', 'admincolors/css/lite.css'),

    ('Dark Blue', 'admincolors/css/dark-blue.css'),

    ('Gray', 'admincolors/css/gray.css')

]

# TEMPLATES configuration

# PS: Don't override your current settings,

#     copy or change only what's necessary

TEMPLATES = [

    {

        ...,

        'DIRS': [

            # IMPORTANT: needed to override the django admin's base templates.

            os.path.join(BASE_DIR, 'templates')

        ],

        # IMPORTANT: needed to load admincolors' templates

        'APP_DIRS': True,

        'OPTIONS': {

            'context_processors': [

                ...,

                # IMPORTANT: needed to make the "theme" and "themes" context

                #            variables available for the templates

                'admincolors.context_processors.admin_theme'

            ],

        },

    },

]

```

### Configure your admin templates

Create a new folder: `BASE_DIR/templates`.

#### admin/base_site.html

##### Completely override the `base_site.html` template

File: `BASE_DIR/templates/admin/base_site.html`

```html

{% extends 'admincolors/base_site.html' %}

```

##### Alternatively, overwrite the file `admin/base_site.html` yourself

File: `BASE_DIR/templates/admin/base_site.html`

```html

{% extends "admin/base_site.html" %}

{% load admincolors %}

{% block blockbots %}

{{ block.super }}

{% colors_styles theme themes %}

{% endblock %}

{% block footer %}

{{ block.super }}

{% colors_scripts %}

{% endblock %}

```

#### admin/index.html

##### Completely override the `index.html` template

File: `BASE_DIR/templates/admin/index.html`

```html

{% extends 'admincolors/index.html' %}

```

##### Alternatively, overwrite the file `admin/index.html` yourself

File: `BASE_DIR/templates/admin/index.html`

```html

{% extends "admin/index.html" %}

{% load admincolors %}

{% block breadcrumbs %}

{% if themes|length > 1 %}



{% colors_breadcrumbs theme themes %}



{% endif %}

{% endblock %}

```


## Custom themes

To add a custom theme, simply create a `.css file` anywhere in your static files, then add its full path (and the theme's name) to the `ADMIN_COLORS` variable in `settings.py`:

```python

ADMIN_COLORS = [

    ...,

    ('My Theme', 'path/to/my/theme.css')

]

```

You can also set multiple `css files` to your theme (or add a custom `.css` to an existing one):

```python

ADMIN_COLORS = [

    ...,

    ('Gray', ('admincolors/css/gray.css', 'path/to/my/custom/file.css')),

    ('My Theme', ('path/to/my/theme.css', 'path/to/another/file.css'))

]

```

## Help

See the Django documentation about:

- [Overrinding templates](https://docs.djangoproject.com/en/2.0/howto/overriding-templates/)

- [The Django admin site](https://docs.djangoproject.com/en/2.0/ref/contrib/admin/)

## Examples

### The default django admin look

![Default](https://github.com/victorfsf/django-admin-colors/raw/master/screenshots/default.png)

### The `Lite` theme

![Lite](https://github.com/victorfsf/django-admin-colors/raw/master/screenshots/lite.png)

### The `Dark Blue` theme

![Dark Blue](https://github.com/victorfsf/django-admin-colors/raw/master/screenshots/darkblue.png)

### The `Gray` theme

![Gray](https://github.com/victorfsf/django-admin-colors/raw/master/screenshots/gray.png)