GitLocker: The Coding Marketplace

Description:

djangocustomadminpages 1.2.5

Django Custom Admin Pages
A django app that lets you add standard class-based views to the django admin index and navigation. Create a view, register it like you would a ModelAdmin, and it appears in the Django Admin Nav.

Check out the full documentation for more in-depth information.
Quick Start

Install the app from pypi pip install django_custom_admin_pages
Remove django.contrib.admin from your installed apps
In your django settings file add the following lines to your `INSTALLED_APPS``:

INSTALLED_APPS = [
# "django.contrib.admin", #REMOVE THIS LINE
# ...
"django_custom_admin_pages",
"django_custom_admin_pages.admin.CustomAdminConfig"
# ...
]

Usage
To create a new custom admin view:

Create a class-based view in django_custom_admin_pages.views which inherits from custom_admin.views.admin_base_view.AdminBaseView.
Set the view class attribute view_name to whatever name you want displayed in the admin index.
Register the view similar to how you would register a ModelAdmin using a custom admin function: admin.site.register_view(YourView).
Use the template django_custom_admin_pages.templates.base_custom_admin.html as a sample for how to extend the admin templates so that your view has the admin nav.

Also see test_proj.test_app.views.example_view.py
Example:
## in django_custom_admin_pages.views.your_special_view.py
from django.contrib import admin
from django.views.generic import TemplateView
from django_custom_admin_pages.views.admin_base_view import AdminBaseView

class YourCustomView(AdminBaseView, TemplateView):
view_name="My Super Special View"
template_name="my_template.html"
route_name="some-custom-route-name" # if omitted defaults to snake_case of view_name
app_label="my_app" # if omitted defaults to "django_custom_admin_pages". Must match app in settings

# always call super() on get_context_data and use it to start your context dict.
# the context required to render admin nav-bar is included here.
def get_context_data(self, *args, **kwargs):
context:dict = super().get_context_data(*args, **kwargs)
# add your context ...
return context

admin.site.register_view(YourCustomView)

Your template should extend admin/base.html or base_custom_admin.html template:

{% extends 'base_custom_admin.html' with title="your page title" %}
{% block content %}
<h1>Hello World</h1>
{% endblock %}

Important: Custom Views Must Be Registered Before Admin URLs are Loaded
Be sure to import the files where your views are stored prior to loading your root url conf. For example:
# project/urls.py
from django.contrib import admin

# importing view before url_patterns ensures it's registered!
from some_app.views import YourCustomView

url_patterns = [
path("admin/", admin.site.urls),
...
]

Configurable Settings

CUSTOM_ADMIN_DEFAULT_APP_LABEL: set to override the default app_label (default: django_custom_admin_pages)

Contributing
Reach out to the author if you'd like to contribute! Also free to file bug reports or feature requests via github issues.
Local Development
To start the test_project:

cd <repo_root>
poetry install --with dev
python test_proj/manage.py migrate
python test_proj/manage.py createsuperuser (follow prompts)
python test_proj/manage.py runserver
Navigate too localhost:8000/admin, log in, and there should be one custom admin view.

To run the test suite:

poetry run pytest

Prior to committing:

Run pylint:

cd <repo_root>
poetry run pylint django_custom_admin_pages/

Run black:

poetry run black .

Run isort:

poetry run isort django_custom_admin_pages/