About

This extension enables you to group, order and customize the Django admin index page without too much hassle or visual changes.

There are 2 concepts: Application groups and Application links. You can create an application group and add any model to it in the Django admin, under Admin index. Whether the models are shown to the user, depends on the regular Django permissions and whether it’s registered in the admin.

An application link is simply a URL with a name that you can add to an application group. It shows as a regular Django model.

One final change in the Django admin is the removal of the App lists, that link to a list of models within an App. This concept became obsolete.

Installation

You can install django_admin_index either via the Python Package Index (PyPI) or from source.

To install using pip:

$ pip install -U django-admin-index

Usage

To use this with your project you need to follow these steps:

1. Add django_admin_index and ordered_model to INSTALLED_APPS in your Django project’s settings.py. Make sure that django_admin_index comes before django.contrib.admin:

   INSTALLED_APPS = (
       "django_admin_index",
       "ordered_model",
       ...,
       "django.contrib.admin",
   )

   Note that there is no dash in the module name, only underscores.

2. Create the database tables by performing a database migration:

   $ python manage.py migrate admin_index

3. Go to the Django admin of your site and look for the “Application groups” section.

Configuration

There are optional settings you can add to your settings.py:

• ADMIN_INDEX_SHOW_REMAINING_APPS (defaults to False)

  Show all models that are not added to an Application group in a group called “Miscellaneous” for staff users.

  NOTE: If no Application groups are defined, it will show all models regardless of this setting.

• ADMIN_INDEX_SHOW_REMAINING_APPS_TO_SUPERUSERS (defaults to True)

  Show all models that are not added a to an Application group in a group called “Miscellaneous” for super users users.

  NOTE: If no Application groups are defined, it will show all models regardless of this setting.

• ADMIN_INDEX_AUTO_CREATE_APP_GROUP (defaults to False)

  Automaticly creates an Application group, based on the app_label, for all the models that would be in the “Miscellaneous” group. If True, your Django admin will initially look as it normally would. It will not update existing Application groups.

• ADMIN_INDEX_SHOW_MENU (defaults to: True)

  Show the admin index as a menu above the breadcrumbs. Submenu’s are filled with the registered models.

• ADMIN_INDEX_HIDE_APP_INDEX_PAGES (defaults to: True)

  Removes the links to the app index pages from the main index and the breadcrumbs.

• ADMIN_INDEX_DISPLAY_DROP_DOWN_MENU_CONDITION_FUNCTION (defaults to django_admin_index.utils.should_display_dropdown_menu)

  A Python dotted path that can be imported to check when the dropdown menu should be displayed in the admin. The default implementation displays this menu if the user is a staff user and ADMIN_INDEX_SHOW_MENU is enabled.

Extra

:root {
  --djai-tab-bg: #ff0080;
  --djai-tab-bg--hover: #a91b60;
}

#header { position: initial; }
.djai-dropdown-menu { position: initial; }

{% block breadcrumbs_pre_changelist %}
› Meaningful breadcrumb element
{% endblock %}

Contributors

Contributors and maintainers can install the project locally with all test dependencies in a virtualenv:

(env) $ pip install -e .[tests,pep8,coverage,release]

(env) $ pytest

(env) $ tox

(env) $ python manage.py runserver

npm install  # one time to get the dependencies installed
npm run watch

npm run scss