Metadata-Version: 1.1
Name: django-star-ratings
Version: 0.4.0
Summary: A Django app to add star ratings to models.
Home-page: https://github.com/wildfish/django-star-ratings
Author: Wildfish
Author-email: developers@wildfish.com
License: BSD License
Description: django-star-ratings
        ===================
        
        |Build Status| |codecov.io|
        
        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>
        
        Template tags
        -------------
        
        The template tag takes two arguments:
        
        -  ``icon_height``: defaults to 32
        -  ``icon_width``: defaults to 32
        
        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
        
        .. |Build Status| image:: https://travis-ci.org/wildfish/django-star-ratings.svg?branch=master
           :target: https://travis-ci.org/wildfish/django-star-ratings
        .. |codecov.io| image:: http://codecov.io/github/wildfish/django-star-ratings/coverage.svg?branch=master
           :target: http://codecov.io/github/wildfish/django-star-ratings?branch=master
        
Keywords: ratings
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
