Differences from Django admin

Django Candy is not a drop-in replacement for Django’s default admin. This document lists the differences in the API.

ModelAdmin class

Candy provides its own ModelAdmin and AdminSite classes. You can’t use Django’s ModelAdmin with Candy.

Import admin from django_candy:

from django_candy import admin

List search

search_fields and get_search_results don’t work in Candy.

Use get_filtered_queryset() to implement searching and filtering.

See Usage docs on list search for details.

List filters

Django admin’s list_filter doesn’t work. Instead, use list_filters (note the extra “s” at the end).

And Candy doesn’t provide automatic filtering. You’re required to filter the results yourself using ModelAdmin().

See Usage docs on list filters for details.