Skip to content

A Django app to check that all models have been added to the Django admin site.

License

Notifications You must be signed in to change notification settings

jdufresne/django-check-admin

Repository files navigation

django-check-admin

django-check-admin is a Django app that adds a system check to verify that all models have been registered with the Django admin site. This check is useful if all models of a project should normally be registered.

Installation

Install the package with pip:

$ pip install django-check-admin

Add 'checkadmin' to INSTALLED_APPS.

INSTALLED_APPS = [
    ...
    'checkadmin',
]

Running

Use the Django management command check:

$ python manage.py check

If a model is not registered with the Django admin site, an error will be emitted. For example:

The model myapp.MyModel is not registered with an admin site.

If specific models should be ignored by the check, use checkadmin.ignore() or define a list of ignored models in your settings with CHECK_ADMIN_IGNORED_MODELS:

import checkadmin
from myapp.models import MyModel

checkadmin.ignore(MyModel)
CHECK_ADMIN_IGNORED_MODELS = ["myapp.MyModel"]

Now, even if MyModel is not registered with an admin site, an error will not be emitted.

About

A Django app to check that all models have been added to the Django admin site.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages