Metadata-Version: 1.1
Name: django_admin_index
Version: 1.3.1
Summary: Admin index for Django.
Home-page: https://github.com/maykinmedia/django-admin-index
Author: Joeri Bekker
Author-email: joeri@maykinmedia.nl
License: BSD
Description: ======================
        Admin Index for Django
        ======================
        
        :Version: 1.3.1
        :Download: https://pypi.python.org/pypi/django_admin_index
        :Source: https://github.com/maykinmedia/django-admin-index
        :Keywords: django, admin, dashboard
        
        |build-status| |coverage| |license| |pyversion| |djversion|
        
        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``:
        
        .. code-block:: console
        
            $ pip install -U django_admin_index
        
        Usage
        =====
        
        To use this with your project you need to follow these steps:
        
        #. 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.
        
        #. Add ``django_admin_index.context_processors.dashboard`` to the context
           processors in your Django project's ``settings.py``::
        
            TEMPLATES = [
                {
                    ...
                    'OPTIONS': {
                        'context_processors': [
                            ...
                            'django_admin_index.context_processors.dashboard'
                        ],
                    },
                },
            ]
        
        #. Create the database tables by performing a database migration:
        
           .. code-block:: console
        
              $ python manage.py migrate admin_index
        
        #. Go to the Django admin of your site and look for the "Application groups"
           section.
        
        Configuration
        =============
        
        There are 3 settings you can add to your ``settings.py``:
        
        - ``ADMIN_INDEX_SHOW_REMAINING_APPS`` (defaults to ``False``)
        
          Show all models that are not added a 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.
        
        
        Extra
        =====
        
        Sticky header
        -------------
        
        The header (typically "Django administration") including the menu (added by this
        library) and the breadcrumbs, all 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; }
            .dropdown-menu { position: initial; }
            .breadcrumbs { position: initial; }
        
        
        Breadcrumbs
        -----------
        
        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 %}
            &rsaquo; Meaningful breadcrumb element
            {% endblock %}
        
        
        .. |build-status| image:: https://secure.travis-ci.org/maykinmedia/django-admin-index.svg?branch=master
            :alt: Build status
            :target: https://travis-ci.org/maykinmedia/django-admin-index
        
        .. |coverage| image:: https://codecov.io/github/maykinmedia/django-admin-index/coverage.svg?branch=master
            :target: https://codecov.io/github/maykinmedia/django-admin-index?branch=master
        
        .. |license| image:: https://img.shields.io/pypi/l/django-admin-index.svg
            :alt: BSD License
            :target: https://opensource.org/licenses/BSD-3-Clause
        
        .. |pyversion| image:: https://img.shields.io/pypi/pyversions/django-admin-index.svg
            :alt: Supported Python versions
            :target: http://pypi.python.org/pypi/django-admin-index/
        
        .. |djversion| image:: https://img.shields.io/badge/django-2.0%2C%202.1%2C%202.2%2C%203.0-blue.svg
            :alt: Supported Django versions
            :target: http://pypi.python.org/pypi/django-admin-index/
        
Keywords: django index dashboard
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Operating System :: OS Independent
Classifier: Topic :: Communications
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: Software Development :: Libraries :: Python Modules
