Skip to main content

Django admin index modules is a Django app that gives you the ability to add widgets modules to the django admin dashboard (admin index)

Project description

Django admin index modules

Django admin index modules is a Django app that gives you the ability to add widgets modules to the django admin dashboard (admin index).

Quick start

  1. Installation:
pip install django-admin-index-modules
  1. comment "django.contrib.admin" and add "django_admin_index_modules.apps.CustomAdminConfig" to your INSTALLED_APPS setting like this:
    INSTALLED_APPS = [
        ...
        #'django.contrib.admin',
        'django_admin_index_modules.apps.CustomAdminConfig',
        ...

        'django.contrib.staticfiles',
        ...

        'django_admin_index_modules.apps.ModulesDashboardsConfig',
        ...
    ]
  1. In admin.py file of any other app create ypur widget module like this:
    from django_admin_index_modules.admin import AdminModuleView

    class VisitorsAdminModuleView(AdminModuleView):

        template_name = 'visitors.html'
        json_method_names = ['post']
        http_method_names = ['get','post']
        permissions = ['is_superuser']
        css = []
        js = []

        def get(self, request, **kwargs):
            context = {
                'stats': "visitors"
            }
            return context
  1. register your widget module using one of those methods:

    1. using register_module(AdminModuleView, position="middle_top") methods:
    from django.contrib import admin

    admin.site.register_module(VisitorsAdminModuleView, position="middle_top")
    1. using @register_module(position="middle_top") decorator:
    from django_admin_index_modules.admin import register_module

    @register_module(position="middle_top")
    class VisitorsAdminModuleView(AdminModuleView):
        ...
    1. position keyword can take one of those values: top, middle_top, middle_bottom and bottom
  1. create template file under "admin/modules/" than the name of the template file assigned to template_name propriety ex: "visitors.html"

  2. Visit http://127.0.0.1:8000/admin/ to see your widget module.

Project details


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_modules-1.0.3.tar.gz (10.4 kB view details)

Uploaded Source

Built Distribution

django_admin_index_modules-1.0.3-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file django_admin_index_modules-1.0.3.tar.gz.

File metadata

  • Download URL: django_admin_index_modules-1.0.3.tar.gz
  • Upload date:
  • Size: 10.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for django_admin_index_modules-1.0.3.tar.gz
Algorithm Hash digest
SHA256 bb1558cf9a6ec8fe9addfd5a55fb511fe13e76bc9c508dcf7a56db8efc6a7c13
MD5 83365d6dfbd26a6c1b91548401c586bc
BLAKE2b-256 fe694c7a2187689c6cb93317b7e4716486465fbe5f049cc4d2593341859fdc85

See more details on using hashes here.

File details

Details for the file django_admin_index_modules-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: django_admin_index_modules-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 21.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.5

File hashes

Hashes for django_admin_index_modules-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 26d191771ef56b2f7aae1527323f0f7dfc5b10ffd31d56edad54e7fbd6625245
MD5 768265907342cd2245e6d77f5603bfa3
BLAKE2b-256 6c57d1425f3178bcc2fb817cd4b9331a3baff7471eda1516d77a03ed2cfd4539

See more details on using hashes here.

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