Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Snippet to automatically create and register admin classes for models.
Python
branch: master
Failed to load latest commit information.
.gitignore Initial commit
README.md Update README.md
autoregister.py Optimized the case, when primary key is either FK or O2O.

README.md

Django admin autoregister

Problem

Even though Django provides a very easy way to create admin views for your models, in 90% of situations you only need to display all the fields in the model with links between the related models. Retyping all the fields for all the models doesn't respect DRY principle.

Solution

One call to autoregister_admin() automatically creates and registers admin for all the models in the specified module with intelligent linking between ForeignKey, OneToOneField and ManyToManyField fields.

Installation

Because this is just a simple code snippet, it doesn't have an app. Instead copy the snippet to some module in your project. E.g.:

<your_project>/utils/autoregister.py

Usage

Supposing you have admin app correctly installed (see Admin installation). In your admin.py files add:

from . import models
from your_project.utils.autoregister import autoregister_admin
autoregister_admin(models)

And that's it! All the models in the module have admin views successfully created and registered.

Customization

exclude_models

To exclude some models and manully create admin for them, use optional exclude_models parameter:

autoregister(models, exclude_models=['ModelName1', 'ModelName2'])

model_fields

To display some additional fields for the models (e.g. some properties), use optional model_fields parameter:

autoregister(models, model_fields={'ModelName': ['property_1', 'property_2']})

exclude_fields

To exclude some fields from displaying, use optional exclude_fields parameter:

autoregister(models, exclude_fields={'ModelName': ['exclude_field1', 'exclude_field2']})

admin_fields

To do a little modifications to the generated admins (e.g. add search fields), use optional admin_fields parameter:

autoregister(models,
  admin_fields={
    'ModelName': {'search_fields': ['name'], 'list_filter': ['active']}
  }
)

reversed_relations

To include links to reversed relations of ForeignKey or Many2Many fields, use optional reversed_relations parameter:

# suppose we have the following models
class Model1(models.Model):
    pass

class Model2(models.Model):
    model1 = models.ForeignKey(Model1)  # this will be added automatically
#-------------------------------------------------------------------------

autoregister(models, reversed_relations={'Model1': ['model2']})
Something went wrong with that request. Please try again.