Skip to main content

django admin helper classes for django-sitecats categories

Project description

django-sitecats-helpers

Django admin helper classes for django-sitecats categories.

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

https://img.shields.io/pypi/v/django-sitecats-helpers.svg https://img.shields.io/pypi/dm/django-sitecats-helpers.svg https://img.shields.io/github/license/bashu/django-sitecats-helpers.svg

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. :-)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-sitecats-helpers-0.0.3.tar.gz (4.9 kB view hashes)

Uploaded Source

Built Distribution

django_sitecats_helpers-0.0.3-py2.py3-none-any.whl (5.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page