django-tag-fields

Add field tags to a Django project


Keywords
Django, tagging
License
BSD-3-Clause
Install
pip install django-tag-fields==4.1.0

Documentation

django-tag-fields

Project Status: Active - The project has reached a stable, usable state and is being actively developed. Supported Python versions Supported Django versions GitHub Actions https://codecov.io/gh/imAsparky/django-tag-fields/branch/main/graph/badge.svg?token=6TPEAAOUUF Documentation Status

This is a clone of Jazzband django-taggit project.

By contributing you agree to abide by the Contributor Code of Conduct.

Note

This project was cloned from django-taggit v3.1.0 and will continue to work in the same way as that version.

Over time I endeavor to extend django-taggit with individual field tagging.

django-tag-fields a simpler approach to tagging with Django. Add "tag_fields" to your INSTALLED_APPS then just add a TaggableManager to your model and go:

from django.db import models

from tag_fields.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.

django-tag-fields requires Django 3.2 or greater.

For more info check out the documentation.

For questions about usage or development you can create an issue on Github (if your question is about usage please add the question label).