django-sitecats-helpers 0.0.3

django admin helper classes for django-sitecats categories

django-sitecats-helpers

Django admin helper classes for django-sitecats categories.

Authored by Basil Shubin, inspired by django-taggit-helpers

Installation

First install the module, preferably in a virtual environment. It can be installed from PyPI:

pip install django-sitecats-helpers

Configuration

First make sure the project is configured for django-sitecats.

Then add the following settings:

INSTALLED_APPS += (
    'sitecats_helpers',
)

Usage

CategoryCounter

Display (and sort by) number of categories associated with objects.

from sitecats_helpers import CategoryCounter
# For Django 1.9+, use this instead:
# from sitecats_helpers.admin import CategoryCounter

class MyModelAdmin(CategoryCounter, admin.ModelAdmin):    # CategoryCounter before ModelAdmin
    list_display = (
        ...
        'category_counter',
    )

CategoryListFilter

Filter records by categories for the current model only.

from sitecats_helpers import CategoryListFilter
# For Django 1.9+, use this instead:
# from sitecats_helpers.admin import CategoryListFilter

class MyModelAdmin(admin.ModelAdmin):
    list_filter = [CategoryListFilter]

CategoryStackedInline

Add stacked inline for categories to admin.

from sitecats_helpers import CategoryStackedInline
# For Django 1.9+, use this instead:
# from sitecats_helpers.admin import CategoryStackedInline

class MyModelAdmin(admin.ModelAdmin):
    inlines = [CategoryStackedInline]

CategoryTabularInline

Add tabular inline for categorise to admin.

from sitecats_helpers import CategoryTabularInline
# For Django 1.9+, use this instead:
# from sitecats_helpers.admin import CategoryTabularInline

class MyModelAdmin(admin.ModelAdmin):
    inlines = [CategoryTabularInline]

Contributing

If you like this module, forked it, or would like to improve it, please let us know! Pull requests are welcome too. :-)