https://github.com/jazzband/django-taggit

Simple tagging for django
https://github.com/jazzband/django-taggit

Last synced: 5 days ago
JSON representation

Simple tagging for django

• Host: GitHub
• URL: https://github.com/jazzband/django-taggit
• Owner: jazzband
• License: bsd-3-clause
• Created: 2009-12-08T23:40:49.000Z (about 15 years ago)
• Default Branch: master
• Last Pushed: 2024-11-05T04:55:28.000Z (about 1 month ago)
• Last Synced: 2024-12-01T16:44:15.322Z (12 days ago)
• Language: Python
• Homepage: https://django-taggit.readthedocs.io
• Size: 1.23 MB
• Stars: 3,341
• Watchers: 63
• Forks: 624
• Open Issues: 94
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Authors: AUTHORS

Awesome Lists containing this project

• best-of-web-python - GitHub - 21% open · ⏱️ 29.05.2024): (Django Utilities)

README

        
django-taggit

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

.. image:: https://jazzband.co/static/img/badge.svg

   :target: https://jazzband.co/

   :alt: Jazzband

.. image:: https://img.shields.io/pypi/pyversions/django-taggit.svg

   :target: https://pypi.org/project/django-taggit/

   :alt: Supported Python versions

.. image:: https://img.shields.io/pypi/djversions/django-taggit.svg

   :target: https://pypi.org/project/django-taggit/

   :alt: Supported Django versions

.. image:: https://github.com/jazzband/django-taggit/workflows/Test/badge.svg

   :target: https://github.com/jazzband/django-taggit/actions

   :alt: GitHub Actions

.. image:: https://codecov.io/gh/jazzband/django-taggit/coverage.svg?branch=master

    :target: https://codecov.io/gh/jazzband/django-taggit?branch=master

This is a `Jazzband `_ project. By contributing you agree

to abide by the `Contributor Code of Conduct

`_ and follow the `guidelines

`_.

``django-taggit`` a simpler approach to tagging with Django.  Add ``"taggit"`` to your

``INSTALLED_APPS`` then just add a TaggableManager to your model and go:

.. code:: python

    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:

.. code:: pycon

    >>> apple = Food.objects.create(name="apple")

    >>> apple.tags.add("red", "green", "delicious")

    >>> apple.tags.all()

    [, , ]

    >>> apple.tags.remove("green")

    >>> apple.tags.all()

    [, ]

    >>> Food.objects.filter(tags__name__in=["red"])

    [, ]

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

``django-taggit`` requires Django 3.2 or greater.

For more info check out the `documentation

`_. And for questions about usage or

development you can create an issue on Github (if your question is about

usage please add the `question` tag).