Skip to main content

Admin index for Django

Project description

Version:
3.1.1
Download:

https://pypi-hypernode.com/pypi/django-admin-index

Source:

https://github.com/maykinmedia/django-admin-index

Keywords:

django, admin, dashboard

Build status Code quality checks black coverage BSD License Supported Python versions Supported Django versions pypi-version

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.

Ordered dashboard with dropdown menu. Manage Application groups. Configure application groups and add Application links.

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

Theming

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.

Contributors

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

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

Running the test suite

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

Developing the frontend

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-admin-index-3.1.1.tar.gz (28.6 kB view details)

Uploaded Source

Built Distribution

django_admin_index-3.1.1-py3-none-any.whl (30.5 kB view details)

Uploaded Python 3

File details

Details for the file django-admin-index-3.1.1.tar.gz.

File metadata

  • Download URL: django-admin-index-3.1.1.tar.gz
  • Upload date:
  • Size: 28.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for django-admin-index-3.1.1.tar.gz
Algorithm Hash digest
SHA256 31ba8b68ec2c89a8872e2dce4dbc668031100ca8616d464efa2fa4467cc0f429
MD5 091040f4a936759e6e1b6c853eb0a221
BLAKE2b-256 a60cf68ce5ddd8b1469a78b81f432f4fa51bdd74a9045c8cada7cc5a7e8a4914

See more details on using hashes here.

Provenance

File details

Details for the file django_admin_index-3.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_admin_index-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6efff9316af395507e6cbea280241ccf23682a0366947542d1b234b8cb643bbc
MD5 dae87b6fcdd274034303b9cd95188f31
BLAKE2b-256 80d20dafcc8cde0783b56126f790e551e3a644d7f7506161685ba7177054c78d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page