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-ratings
add star_ratings
to INSTALLED_APPS
:
INSTALLED_APPS = (
...
'star_ratings'
)
sync your database:
python manage.py migrate
add 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 four arguments:
icon_height
: defaults toSTAR_RATINGS_STAR_HEIGHT
icon_width
: defaults toSTAR_RATINGS_STAR_WIDTH
read_only
: overrides theeditable
behaviour to make the widget read onlytemplate_name
: overrides the tempalte to use for the widget
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')
In some cases you may need to create your own rating model. This is possible by setting STAR_RATING_RATING_MODEL
in your settings file. This can be useful to add additional fields or methods to the model. This is very similar to the how django handles swapping the user model (see [https://docs.djangoproject.com/en/1.10/topics/auth/customizing/#substituting-a-custom-user-model]).
For ease AbstractBaseRating
is supplied. For example if you wanted to add the field foo
to the rating model you would need to crate your rating model extending AbstractBaseRating
:
./myapp/models.py
class MyRating(AbstractBaseRating):
foo = models.TextField()
And add the setting to the setting file:
./settings.py
...
STAR_RATINGS_RATING_MODEL = 'myapp.MyRating'
...
One use case for changing the rating model would be to change the pk type of the related object. By default we assume the pk of the rated object will be a positive integer field which is fine for most uses, if this isn't though you will need to override the object_id
field on the rating model. As of django 1.10 you can now hide fields form parent abstract models, so to change the object_id
to a CharField
you can do something like:
class MyRating(AbstractBaseRating):
object_id = models.CharField(max_length=10)
To run the test use:
$> ./runtests.py
Travis is setup to push releases to pypi automatically on tags, to do a release:
- Up version number.
- Update release notes.
- Push dev.
- Merge develop into master.
- Tag with new version number.
- Push tags.