Python 3 compatible ratings for Django.
Add ratings to any Django model with a template tag.
See full documentation.
Install from PyPI:
pip install django-star-ratingsadd star_ratings to INSTALLED_APPS:
INSTALLED_APPS = (
...
'star_ratings'
)sync your database:
python manage.py migrateadd the following to your urls.py:
url(r'^ratings/', include('star_ratings.urls', namespace='ratings', app_name='ratings')),Make sure 'django.core.context_processors.request', is in TEMPLATE_CONTEXT_PROCESSORS.
Add the following javascript and stylesheet to your template
{% load static %}
<html>
...
<link rel="stylesheet" href="{% static 'star-ratings/css/star-ratings.css' %}">
<script type="text/javascript" src="{% static 'star-ratings/js/dist/star-ratings.min.js' %}"></script>
...
</html>To enable ratings for a model add the following tag in your template
{% load ratings %}
<html>
...
{% ratings object %}
...
</html>The template tag takes two arguments:
icon_height: defaults toSTAR_RATINGS_STAR_HEIGHTicon_width: defaults toSTAR_RATINGS_STAR_WIDTHread_only: overrides theeditablebehaviour to make the widget read only
To prohibit users from altering their ratings set STAR_RATINGS_RERATE = False in settings.py
To change the number of rating stars, set STAR_RATINGS_RANGE (defaults to 5)
To enable anonymous rating set STAR_RATINGS_ANONYMOUS = True.
If anonymous rating is enabled only the ip address for the rater will be stored (even if the user is logged in). When a user rates an object a preexisting object will not be searched for, instead a new rating object will be created
If this value is changed your lookups will return different results!
To control the default size of stars in pixels set the values of STAR_RATINGS_STAR_HEIGHT and STAR_RATINGS_STAR_WIDTH. By default STAR_RATINGS_STAR_WIDTH is the same as STAR_RATINGS_STAR_HEIGHT and STAR_RATINGS_STAR_HEIGHT defaults to 32.
To change the star graphic, add a sprite sheet to /static/star-ratings/images/stars.png with the states aligned horizontally. The stars should be laid out in three states: full, empty and active.
You can also set STAR_RATINGS_STAR_SPRITE to the location of your sprite sheet.
You can customize ratings widget by creating star_ratings/widget.html. For example :
{% extends "star_ratings/widget_base.html" %}
{% block rating_detail %}
Whatever you want
{% endblock %}See star_ratings/widget_base.html for other blocks to be extended.
The easiest way to order by ratings is to add a GenericRelation to the Rating model from your model:
from django.contrib.contenttypes.fields import GenericRelation
from star_ratings.models import Rating
class Foo(models.Model):
bar = models.CharField(max_length=100)
ratings = GenericRelation(Rating, related_query_name='foos')
Foo.objects.filter(ratings__isnull=False).order_by('ratings__average')To run the test use:
$> ./runtests.pyTravis is setup to push releases to pypi automatically on tags, to do a release: 1. Up version number. 2. Update release notes. 3. Push dev. 4. Merge develop into master. 5. Tag with new version number. 6. Push tags.