Django Admin Plus

Custom Wiews for Django Admin made simple.

AdminPlus aims to be the smallest possible extension to the excellent Django admin component that lets you add admin views that are not tied to models.

📜 About and Motivation

Forked from https://github.com/jsocol/django-adminplus

There are packages out there, like Nexus and django-admin-tools that replace the entire admin. Nexus supports adding completely new "modules" (the Django model admin is a default module) but there seems to be a lot of boiler plate code to do it. django-admin-tools does not, as far as I can tell, support adding custom pages.

All AdminPlus does is allow you to add simple custom views (well, they can be as complex as you like!) without mucking about with hijacking URLs, and providing links to them right in the admin index.

✨ Features

• Register custom views to the Django admin that are not tied to any model.
• Support for both function-based and class-based views.
• Decorator syntax for registering views (@admin.site.register_view).
• Customizable display names for views in the admin index.
• Named URL patterns for use with reverse() and redirect().
• Conditional visibility control via boolean or callable visible parameter.
• Automatic admin authentication wrapping for all registered views.
• Custom admin index template with a "Custom Views" section.
• Drop-in replacement for Django's AdminSite with AdminSitePlus.
• Base template with breadcrumb navigation for admin-styled pages.
• Fully compatible with the built-in Django admin module.

📋 Requirements

• Python 3.11 or higher
• Django 4.2 or higher

📦 Installation

Using pip

pip install django-sb-adminplus

Using uv

uv add django-sb-adminplus

🚀 Usage

And add django_sb_adminplus to your installed apps, and replace django.contrib.admin with django.contrib.admin.apps.SimpleAdminConfig:

INSTALLED_APPS = (
    'django.contrib.admin.apps.SimpleAdminConfig',
    # ...
    'django_sb_adminplus',
    # ...
)

To use AdminPlus in your Django project, you'll need to replace django.contrib.admin.site, which is an instance of django.contrib.admin.sites.AdminSite. I recommend doing this in urls.py right before calling admin.autodiscover():

# urls.py
from django.contrib import admin
from django.urls import path
from django_sb_adminplus.sites import AdminSitePlus

admin.site = AdminSitePlus()
admin.autodiscover()

urlpatterns = [
    # ...
    # Include the admin URL conf as normal.
    path('admin/', admin.site.urls),
    # ...
]

Congratulations! You're now using AdminPlus.

Create custom views

So now that you've installed AdminPlus, you'll want to use it. AdminPlus is 100% compatible with the built in admin module, so if you've been using that, you shouldn't have to change anything.

AdminPlus offers a new function, admin.site.register_view, to attach arbitrary views to the admin:

# someapp/admin.py
# Assuming you've replaced django.contrib.admin.site as above.
from django.contrib import admin

def my_view(request, *args, **kwargs):
    pass

admin.site.register_view('somepath', view=my_view)

# And of course, this still works:
from someapp.models import MyModel
admin.site.register(MyModel)

Now my_view will be accessible at admin/somepath and there will be a link to it in the Custom Views section of the admin index.

You can also use register_view as a decorator:

@admin.site.register_view('somepath')
def my_view(request):
    pass

register_view takes some optional arguments:

• name: a friendly name for display in the list of custom views. For example:

  def my_view(request):
      """Does something fancy!"""
  admin.site.register_view('somepath', 'My Fancy Admin View!', view=my_view)
  

• urlname: give a name to the urlpattern so it can be called by redirect(), reverse(), etc. The view will be added to the admin namespace, so a urlname of foo would be reversed with reverse("admin:foo").

• visible: a boolean or a callable returning one, that defines if the custom view is visible in the admin dashboard.

All registered views are wrapped in admin.site.admin_view.

Note

Views with URLs that match auto-discovered URLs (e.g. those created via ModelAdmins) will override the auto-discovered URL.