A Django app to add star ratings to models.
Project description
Python 3 compatible ratings for Django.
Add ratings to any Django model with a template tag.
Installation
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.
Usage
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>
Settings
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)
Changing the star graphics
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.
Customize widget template
You can customize ratings widget by creating star_ratings/widget.html. For example :
{% extends "star_ratings/widget_base.html" %} {% block ratings_detail %} Whatever you want {% endblock %}
See star_ratings/widget_base.html for other blocks to be extended.
Ordering by ratings
The easiest way to order by ratings is to add a GenericRelation to the Rating model from your model:
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')
Running tests
To run the test use:
$> ./runtests.py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-star-ratings-0.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3062306578ac3a649e205f1643ac5d26a9b027ac456db17cf2dd26ad71603240 |
|
MD5 | b895df35a71ea532ca72b6c8454327ad |
|
BLAKE2b-256 | 4ba7a025a3591e8637d5a49b8e60e121f38bffdc73f4a63f0258eecf24219032 |
Hashes for django_star_ratings-0.5.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8ceee6a61a21236078f27fd0f626208a9574aff9b969503cb820838fd6c0f96e |
|
MD5 | 311ec122b94ede5e35f575bade191b4f |
|
BLAKE2b-256 | 6231262f9a6e588f0785c8430c3aa38e39a459d6767d71e52700579137ba1bd5 |