django-user-tags 1.1

A reusable Django app that enables users of your site to tag items
django-user-tags is a Django app for allowing users to add tags to any object. Each user's tags are nicely separated so that the auto-suggest functionality will never suggest tags that have been entered by a different user (unless you want so).

Installation

You need to install the following prerequisites in order to use this app:

pip install Django
pip install South


If you want to install the latest stable release from PyPi:

 pip install django-user-tags

If you feel adventurous and want to install the latest commit from GitHub:

 pip install -e git://github.com/bitmazk/django-user-tags.git#egg=user_tags

Add user_tags to your INSTALLED_APPS:

INSTALLED_APPS = (
 ...,
 'user_tags',
)


Don't forget to migrate your database:

./manage.py migrate user_tags

Add jQuery and jQuery UI and tag-it to your base template or at least to the template that should display forms with tag fields:

< script src="http://ajax.googleapis.com/ajax/libs/jquery/1.5.2/jquery.min.js" type="text/javascript" charset="utf-8" >< /script >
< script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.12/jquery-ui.min.js" type="text/javascript" charset="utf-8" >< /script >
< script src="{{ STATIC_URL }}user_tags/js/tag-it.js" type="text/javascript" charset="utf-8" >< /script >


Also add a jQuery UI theme and the tag-it theme to your template:

< link rel="stylesheet" type="text/css" href="http://ajax.googleapis.com/ajax/libs/jqueryui/1/themes/flick/jquery-ui.css" >
< link href="{{ STATIC_URL }}user_tags/css/jquery.tagit.css" rel="stylesheet" type="text/css" >


Usage

First you need to modify the model that should be able to hold tags:

class YourModel(models.Model):
 TAG_FIELDS = [
 {
 'name': 'tags',
 'verbose_name': _('Tags'),
 'help_text': _('Help text'),
 'with_user': True,
 },
 {
 'name': 'global_tags',
 'verbose_name': _('Global Tags'),
 'with_user': False,
 }
 ]


TAG_FIELDS is a list of dictionaries. Each dictionary can have the following keys:

1. name (mandatory). This will be the name of the tag group in the database and also the form field's name.
2. verbose_name. This will be the label of the form field. If not provided it will be the same as name.
3. With user. If True, the item that gets tagged must have a ForeignKey to a User object or provide a get_user method. If False we assume that the tags for this item are global.

Next you would create a ModelForm for your taggable model:

from django import forms
from user_tags.forms import UserTagsFormMixin
from your_app.models import YourModel

class YourModelForm(UserTagsFormMixin, forms.ModelForm):
 class Meta:
 model = DummyModel


The UserTagsFormMixin will do the magic for you and add a form field for every item in TAG_FIELDS on your model. These fields will have a class tagItInput, which will enable you execute the following JavaScript on the page that holds the form:

< script type="text/javascript" >
$(document).ready(function() {
 $(".tagItInput").tagit({
 allowSpaces: true,
 availableTags: ["c++", "java", "php", "javascript", "ruby", "python", "c"],
 caseSensitive: false
 });
});
< /script >


This is just a sane set of settings that we like to use. You can of course tweak that to your liking. See the tag-it documentation for further reference.

Contribute

If you want to contribute to this project, please perform the following steps:

# Fork this repository
# Clone your fork
$ mkvirtualenv -p python2.7 django-online-docs
$ pip install -r requirements.txt
$ ./online_docs/tests/runtests.sh
# You should get no failing tests

$ git co -b feature_branch master
# Implement your feature and tests
$ ./online_docs/tests/runtests.sh
# You should still get no failing tests
# Describe your change in the CHANGELOG.txt
$ git add . && git commit
$ git push origin feature_branch
# Send us a pull request for your feature branch


Whenever you run the tests a coverage output will be generated in tests/coverage/index.html. When adding new features, please make sure that you keep the coverage at 100%.

If you are making changes that need to be tested in a browser (i.e. to the CSS or JS files), you might want to setup a Django project, follow the installation insttructions above, then run python setup.py develop. This will just place an egg-link to your cloned fork in your project's virtualenv.

last updated on:
July 25th, 2012, 12:33 GMT
price:
FREE!
developed by:
Martin Brochhaus
homepage:
github.com
license type:
MIT/X Consortium License 
category:
ROOT \ Internet \ Django Plugins

FREE!

In a hurry? Add it to your Download Basket!

user rating

UNRATED
0.0/5
 

0/5

Rate it!

98 DOWNLOADS

Add your review!

SUBMIT