django-admin-appmenu 1.0.0

Templatetag to render an application menu in the Django admin.

django-admin-appmenu provides a templatetag that renders an application menu in the Django admin.

Installation

Use pip to install the download and install the package from PyPi:

pip install django-admin-appmenu

Or checkout the source code from Github:

git clone https://github.com/collab-project/django-admin-appmenu.git
cd django-admin-appmenu
pip install -e .

Add admin_appmenu to INSTALLED_APPS in your Django project settings:

INSTALLED_APPS = (
    ...

    'admin_appmenu',
)

Usage

Override the admin/base.html template and make the tag available in the template:

{% load navigation %}

Now add the admin_navigation tag to the template:

{% admin_navigation %}

After reloading the admin you will see the new menu.

To customize the output of the tag create and customize a copy of the admin_appmenu/navigation.html template.

Custom admin site

By default the standard Django admin site (django.contrib.admin.site) is used to build the menu tree. If your project uses a customized admin site set the ADMIN_APPMENU_CLASS setting to the path of the custom admin site instance.

For example in settings.py:

ADMIN_APPMENU_CLASS = 'myapp.admin.admin_site'

This also allows you to sort and format the applications list used to render the menu.