Version: | 4.0.0 |
---|---|
Download: | https://pypi.org/project/django-admin-index/ |
Source: | https://github.com/maykinmedia/django-admin-index |
Keywords: | django, admin, dashboard |
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.
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
To use this with your project you need to follow these steps:
Add
django_admin_index
andordered_model
toINSTALLED_APPS
in your Django project'ssettings.py
. Make sure thatdjango_admin_index
comes beforedjango.contrib.admin
:INSTALLED_APPS = ( "django_admin_index", "ordered_model", ..., "django.contrib.admin", )
Note that there is no dash in the module name, only underscores.
Create the database tables by performing a database migration:
$ python manage.py migrate admin_index
Go to the Django admin of your site and look for the "Application groups" section.
There are optional settings you can add to your settings.py
:
ADMIN_INDEX_SHOW_REMAINING_APPS
(defaults toFalse
)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 toTrue
)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 toFalse
)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 todjango_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.
By default, django-admin-index tabs/dropdowns are styled in the Django admin theme
colours. On Django 3.2+ these are controlled through CSS variables in the
static/admin/css/base.css
stylesheet. These CSS variables are used as defaults for
django-admin-index' own CSS variables.
See scss/_vars.scss
for all the available CSS variables you can use to customize
the color palette. A simple example:
:root {
--djai-tab-bg: #ff0080;
--djai-tab-bg--hover: #a91b60;
}
Any rules not supported by CSS vars can be overridden with regular CSS. All elements
have CSS class names following the BEM methodology, such as
.djai-dropdown-menu__item
and
.djai-dropdown-menu__item.djai-dropdown-menu__item--active
.
The header (typically "Django administration") including the menu (added by this library) become sticky (ie. they stay visible when you scroll down on large pages). If you don't want this, you can add some CSS lines, like:
#header { position: initial; }
.djai-dropdown-menu { position: initial; }
You can also squeeze additional content in the breadcrumbs, just after
Home
. Simply overwrite the block breadcrumbs_pre_changelist
in the
admin templates you desire (change_list.html
, change_form.html
, etc.)
{% block breadcrumbs_pre_changelist %}
› Meaningful breadcrumb element
{% endblock %}
Contributors and maintainers can install the project locally with all test dependencies in a virtualenv:
(env) $ pip install -e .[tests,pep8,coverage,release]
To run the tests for a single environment (currently installed in your virtualenv), use
pytest
:
(env) $ pytest
To run the complete build matrix, use tox
:
(env) $ tox
To develop the stylesheets, you can use the included test project:
(env) $ python manage.py runserver
You also want to install the frontend tooling and run the SCSS compilation to CSS in watch mode:
npm install # one time to get the dependencies installed
npm run watch
Once the result is satisfactory, you can make a production build of the stylesheets:
npm run scss
Then, commit the changes and make a pull request.