Metadata-Version: 1.1
Name: django-sitecats-helpers
Version: 0.0.2
Summary: django admin helper classes for django-sitecats categories
Home-page: https://github.com/bashu/django-sitecats-helpers
Author: Basil Shubin
Author-email: basil.shubin@gmail.com
License: MIT License
Download-URL: https://github.com/bashu/django-sitecats-helpers/zipball/master
Description: django-sitecats-helpers
        =======================
        
        Django admin helper classes for django-sitecats_ categories.
        
        Authored by `Basil Shubin <http://github.com/bashu>`_, inspired by django-taggit-helpers_
        
        .. image:: https://img.shields.io/pypi/v/django-sitecats-helpers.svg
            :target: https://pypi.python.org/pypi/django-sitecats-helpers/
        
        .. image:: https://img.shields.io/pypi/dm/django-sitecats-helpers.svg
            :target: https://pypi.python.org/pypi/django-sitecats-helpers/
        
        .. image:: https://img.shields.io/github/license/bashu/django-sitecats-helpers.svg
            :target: https://pypi.python.org/pypi/django-sitecats-helpers/
        
        .. image:: https://landscape.io/github/bashu/django-sitecats-helpers/develop/landscape.svg?style=flat
            :target: https://landscape.io/github/bashu/django-sitecats-helpers/develop
        
        Installation
        ============
        
        First install the module, preferably in a virtual environment. It can be installed from PyPI:
        
        .. code-block:: shell
        
            pip install django-sitecats-helpers
        
        
        Configuration
        -------------
        
        First make sure the project is configured for django-sitecats_.
        
        Then add the following settings:
        
        .. code-block:: python
        
            INSTALLED_APPS += (
                'sitecats_helpers',
            )
        
        
        Usage
        =====
        
        CategoryCounter
        ---------------
        
        Display (and sort by) number of categories associated with objects.
        
        .. code-block:: python
        
            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.
        
        .. code-block:: python
        
            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.
        
        .. code-block:: python
        
            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.
        
        .. code-block:: python
        
            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. :-)
        
        .. _django-sitecats: https://github.com/idlesign/django-sitecats
        .. _django-taggit-helpers: https://github.com/mfcovington/django-taggit-helpers
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires: Django (>=1.4)
