Skip to content

Latest commit

 

History

History
77 lines (48 loc) · 2.04 KB

README.md

File metadata and controls

77 lines (48 loc) · 2.04 KB

django-taggit

django-taggit is a simpler approach to tagging with Django.

Differences between this fork and original django-taggit

  • some bugfixes
  • added ability to have more tag fields for one model
  • dropped support of Django < 1.3

Getting Started

This is unofficial fork of django-taggit, you have to install it from github: pip::

$ pip install git+git://github.com/yedpodtrzitko/django-taggit.git

Add "taggit" to your INSTALLED_APPS then just add a TaggableManager to your model and go::

from django.db import models

from taggit.managers import TaggableManager

class Food(models.Model):
    # ... fields here

    tags = TaggableManager()

Then you can use the API like so::

>>> apple = Food.objects.create(name="apple")
>>> apple.tags.add("red", "green", "delicious")
>>> apple.tags.all()
[<Tag: red>, <Tag: green>, <Tag: delicious>]

>>> apple.tags.remove("green")
>>> apple.tags.all()
[<Tag: red>, <Tag: delicious>]

>>> Food.objects.filter(tags__name__in=["red"])
[<Food: apple>, <Food: cherry>]

Tags will show up for you automatically in forms and the admin.

If you want to enforce lowercase tags everywhere (recommended, to avoid ending up with tags 'Music' and 'music' which are functionally identical but show up in different taxonomies), add to settings.py:

TAGGIT_FORCE_LOWERCASE = True

If you want to prevent certain words from being added as tags (such as English articles to, from, the, of, etc.) add to settings.py:

TAGGIT_STOPWORDS = [u'a', u'an', u'and', u'be', u'from', u'of']

Requirements

This django-taggit fork requires Django 1.3 or greater.

Further Infos

For more info about official django-taggit:

you can checkout out the documentation

And for questions about usage or development you can contact the mailinglist