Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/radiac/django-tagulous
Fabulous Tagging for Django
https://github.com/radiac/django-tagulous
Last synced: 2 days ago
JSON representation
Fabulous Tagging for Django
- Host: GitHub
- URL: https://github.com/radiac/django-tagulous
- Owner: radiac
- License: other
- Created: 2015-05-11T15:30:35.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-08-27T23:31:16.000Z (5 months ago)
- Last Synced: 2025-01-17T02:00:12.233Z (9 days ago)
- Language: Python
- Homepage: http://radiac.net/projects/django-tagulous/
- Size: 1.76 MB
- Stars: 344
- Watchers: 9
- Forks: 66
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.rst
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - django-tagulous - Fabulous Tagging for Django (Python)
README
# Django Tagulous - Fabulous Tags
[](https://pypi.org/project/django-tagulous/)
[](https://django-tagulous.readthedocs.io/en/latest/)
[](https://github.com/radiac/django-tagulous/actions/workflows/ci.yml)
[](https://codecov.io/gh/radiac/django-tagulous)
A tagging library for Django. Built on ForeignKey and ManyToManyField to support tag
strings as well as native ORM queries.
Use a `SingleTagField` as a CharField with dynamic choices, or a `TagField` for
conventional tagging or nested categorisation.
* [Project site](https://radiac.net/projects/django-tagulous/)
* [Source code](https://github.com/radiac/django-tagulous)
* [Documentation](https://django-tagulous.readthedocs.io/)
* [Changelog](https://django-tagulous.readthedocs.io/en/latest/changelog.html)
## Features
* Easy to install - simple requirements, **simple syntax**, lots of options
* Based on ForeignKey and ManyToManyField, so it's **easy to query**
* **Autocomplete** support built in, if you want it
* Supports multiple **independent fields** on a single model
* Supports **trees of nested tags**, for detailed categorisation
* Admin support for managing tags and tagged models
Supports Django 3.2+, on Python 3.10+.
See the [Documentation](https://django-tagulous.readthedocs.io/)
for details of how Tagulous works; in particular:
* [Installation](https://django-tagulous.readthedocs.io/en/latest/installation.html) -
how to install Tagulous
* [Example Usage](https://django-tagulous.readthedocs.io/en/latest/usage.html) -
see examples of Tagulous in use
* [Upgrading](https://django-tagulous.readthedocs.io/en/latest/upgrading.html) -
how to upgrade Tagulous, and see what has changed in the
[changelog](https://django-tagulous.readthedocs.io/en/latest/changelog.html)
* [Contributing](https://django-tagulous.readthedocs.io/en/latest/contributing.html) -
for how to contribute to Tagulous
Quickstart
==========
Install with `pip install django-tagulous`, add `tagulous` to Django's `INSTALLED_APPS`
and
[define the serializers](http://radiac.net/projects/django-tagulous/documentation/installation/),
then start adding tag fields to your model:
```python
from django.db import models
from tagulous.models import SingleTagField, TagField
class Person(models.Model):
name = models.CharField(max_length=255)
title = SingleTagField(initial="Mr, Mrs, Miss, Ms")
skills = TagField()
```
You can now set and get them using strings, lists or querysets::
```python
myperson = Person.objects.create(name='Bob', title='Mr', skills='run, hop')
# myperson.skills == 'run, hop'
myperson.skills = ['jump', 'kung fu']
myperson.save()
# myperson.skills == 'jump, "kung fu"'
runners = Person.objects.filter(skills='run')
```
Behind the scenes each tag field is a `ForeignKey` or `ManyToManyField` relationship to
a separate model (by default), so more complex queries are simple::
```python
qs = MyRelatedModel.objects.filter(
person__skills__name__in=['run', 'jump'],
)
```
As well as this you also get autocompletion in public and admin forms,
automatic slug generation, unicode support, you can build tag clouds easily,
and can nest tags for more complex categorisation.