Skip to main content

Django jQuery Tags Input is a Django field and widget wrapper that adds an easy to use interface for `ManyToManyField` and `ForeignKey` fields in the forms of autocompleting tags with optionally live creation of new linked items

Project description

Overview

Django Tags Input is a module that gives you a modified version of the Xoxco jQuery Tags Input library within Django.

The result is a very pretty interface with tags and autocomplete which can optionally automatically create new items when they are missing.

One of the most useful features of Django Tags Input is that it stores the elements in the order which you input.

So if you insert B, A, C into the database, it will return it sorted the way you entered it: B, A, C.

https://raw.githubusercontent.com/WoLpH/django-tags-input/master/docs/example.png

How to install

Installing this module only takes a couple of minutes.

Currently Django 1.4, Django 1.5, Django 1.6, Django 1.7 and Django 1.8 are supported in combination with Python 2.6 and 2.7. Python 3.2, 3.3 and 3.4. Pypy and Pypy3.

  1. Install the module itself

    pip install django-tags-input

    # or

    easy_install django-tags-input

  2. Add tags_input to your INSTALLED_APPS setting in the Django settings.py.

    Example:

    INSTALLED_APPS = (
        # ... your other installed apps
        'tags_input',
    )
  3. Add the mappings to your settings.py file:

    Example:

    TAGS_INPUT_MAPPINGS = {
        'some_app.SomeKeyword': {
            'field': 'some_field',
        },
        'some_app.SomeOtherKeyword': {
            'fields': ('some_field', 'some_other_field'),
        },
        'some_app.SomeSortedKeyword': {
            'field': 'some_field',
            'ordering': [
                'some_field',
                'some_other_field',
            ],
            'filters': {
                'some_field__istartswith': 'a',
            },
            'excludes': {
                'some_field__iexact': 'foobar',
            },
        },
        'some_app.SomeCreateableKeyword': {
            'field': 'some_field',
            'create_missing': True,
        },
    }
  4. Add the tags_input urls to your urls.py:

    Example:

    from django.conf import urls
    
    urlpatterns = patterns('',
        url(r'^tags_input/', include('tags_input.urls', namespace='tags_input')),
        # ... other urls ...
    )

Admin usage

from django.contrib import admin
import models
from tags_input import admin as tags_input_admin

class YourAdmin(tags_input_admin.TagsInputAdmin):
    pass

admin.site.register(models.YourModel, YourAdmin)

Quickstart

To test the project simply clone the repository, install and run the example:

mkvirtualenv django-tags-input
git clone https://github.com/WoLpH/django-tags-input.git
pip install -e django-tags-input
cd django-tags-input/example
python manage.py runserver

Now you can go to http://localhost:8000/admin/ and login with username and password admin and admin respectively.

After this you can try adding some extra Foo objects through the Spam admin here: http://localhost:8000/admin/autocompletionexample/spam/2/

Note that some parts of the example are deliberately broken to test the behaviour in broken environments.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-tags-input-2.0.1.tar.gz (115.4 kB view details)

Uploaded Source

File details

Details for the file django-tags-input-2.0.1.tar.gz.

File metadata

File hashes

Hashes for django-tags-input-2.0.1.tar.gz
Algorithm Hash digest
SHA256 c275ee4c13f7cc60affbce3ed445cc980099949d530fa3c020406937e5879880
MD5 64cdb28c04cbe4abbb1ae474a4c97eca
BLAKE2b-256 91aa403af46bfd57cc7e93209c1d7598c2f58d607d081fcf0586e348dd606aea

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page