https://github.com/mfcovington/django-taggit-helpers

Django admin helper classes for django-taggit tags
https://github.com/mfcovington/django-taggit-helpers

Last synced: 5 months ago
JSON representation

Django admin helper classes for django-taggit tags

• Host: GitHub
• URL: https://github.com/mfcovington/django-taggit-helpers
• Owner: mfcovington
• License: bsd-3-clause
• Created: 2015-06-09T03:11:26.000Z (over 10 years ago)
• Default Branch: develop
• Last Pushed: 2023-09-28T14:05:25.000Z (about 2 years ago)
• Last Synced: 2025-05-24T07:53:35.650Z (7 months ago)
• Language: Python
• Homepage: https://pypi.python.org/pypi/django-taggit-helpers/
• Size: 532 KB
• Stars: 31
• Watchers: 4
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-django - django-taggit-helpers - Django admin helper classes for django-taggit tags. (Tagging)
• awesome-django - django-taggit-helpers - Django admin helper classes for django-taggit tags. (Tagging)
• awesome-django-cn - django-taggit-helpers, star:17 - django-taggit 标签的 Django 后台管理辅助类（1 年未更新）。 (标签)

README

          
*********************

django-taggit-helpers

*********************

``django-taggit-helpers`` makes it easier to work with admin pages of models associated with ``django-taggit`` tags.

Source code is available on GitHub at `mfcovington/django-taggit-helpers `_. Information about ``django-taggit`` is available on `GitHub `_ and `Read the Docs `_.

``django-taggit-helpers`` is compatible with Python 2.7+/3.2+ and Django 1.7+.

.. contents:: :local:

Installation

============

**PyPI**

.. code-block:: sh

    pip install django-taggit-helpers

**GitHub (development branch)**

.. code-block:: sh

    pip install git+http://github.com/mfcovington/django-taggit-helpers.git@develop

Configuration

=============

Add ``taggit_helpers`` to ``INSTALLED_APPS`` in ``settings.py``:

.. code-block:: python

    INSTALLED_APPS = (

        ...

        'taggit',

        'taggit_helpers',

    )

Helper Classes

==============

``TaggitCounter``

-----------------

Display (and sort by) number of Taggit tags associated with tagged items.

.. code-block:: python

    from taggit_helpers import TaggitCounter

    # For Django 1.9+, use this instead:

    # from taggit_helpers.admin import TaggitCounter

    class MyModelAdmin(TaggitCounter, admin.ModelAdmin):    # TaggitCounter before ModelAdmin

        list_display = (

            ...

            'taggit_counter',

        )

*Note:* Currently, the ``TaggableManager()`` field must be named ``tags``.

*Note:* To avoid overcounting, set ``distinct=True`` if further annotating the queryset with ``Count()``:

.. code-block:: python

    queryset.annotate(m2m_field_count=Count('m2m_field', distinct=True))

``TaggitListFilter``

--------------------

Filter records by Taggit tags for the current model only.

Tags are sorted alphabetically by name.

.. code-block:: python

    from taggit_helpers import TaggitListFilter

    # For Django 1.9+, use this instead:

    # from taggit_helpers.admin import TaggitListFilter

    class MyModelAdmin(admin.ModelAdmin):

        list_filter = [TaggitListFilter]

``TaggitStackedInline``

-----------------------

Add stacked inline for Taggit tags to admin.

Tags are sorted alphabetically by name.

.. code-block:: python

    from taggit_helpers import TaggitStackedInline

    # For Django 1.9+, use this instead:

    # from taggit_helpers.admin import TaggitStackedInline

    class MyModelAdmin(admin.ModelAdmin):

        inlines = [TaggitStackedInline]

``TaggitTabularInline``

-----------------------

Add tabular inline for Taggit tags to admin.

Tags are sorted alphabetically by name.

.. code-block:: python

    from taggit_helpers import TaggitTabularInline

    # For Django 1.9+, use this instead:

    # from taggit_helpers.admin import TaggitTabularInline

    class MyModelAdmin(admin.ModelAdmin):

        inlines = [TaggitTabularInline]

Upgrading existing projects to Django 1.9+

==========================================

App loading was refactored in Django 1.9. To make a Django 1.7/1.8 app Django 1.9-compatible with respect to ``django-taggit-helpers``, run the following shell command in your app's directory.

.. code-block:: sh

    find . -name '*.py' | xargs perl -i -pe 's/from taggit_helpers import/from taggit_helpers.admin import/'

Thanks to `jpic `_ for the `inspiration `_ for this snippet!

Issues

======

If you experience any problems or would like to request a feature, please `create an issue `_ on GitHub.

*Version 0.1.4*