skip to navigation
skip to content

django-review 1.3

A reusable Django app that lets users write reviews for any model

Latest Version: 1.9.7

Django Review

A reusable Django app that lets users write reviews for any model


To get the latest stable release from PyPi

.. code-block:: bash

$ pip install django-review

To get the latest commit from GitHub

.. code-block:: bash

$ pip install -e git+git://

TODO: Describe further installation steps (edit / remove the examples below):

Add ``review`` to your ``INSTALLED_APPS``

.. code-block:: python


Add the ``review`` URLs to your ````

.. code-block:: python

urlpatterns = patterns('',
url(r'^review/', include('review.urls')),

Don't forget to migrate your database

.. code-block:: bash

./ migrate review


The only step you'll have to take is to link to the review views. For example,
you created a ``Book`` model, which should be reviewed by users.

Create a button and add some markup like:

.. code-block:: html

<a href="{% url " review_create"="" content_type="book" object_id="" %}"="">{% trans "Review this book" %}</a>


Default behaviour:

* Users can rate form 0 to 5
* Only authenticated users can post a review
* Users can post multiple reviews on one object
* Users can always update their posted reviews

If you want to change this behaviour, or if you like to add some more
permission checks, read on.


If you want other rating choices than 0-5, you can define a new tuple, like:

.. code-block:: python

('1', 'bad'),
('2', 'average'),
('3', 'excellent'),


Allows anonymous review postings, if set to ``True``.


Name of the URL to redirect to after deleting a review instance. This could
be your review listing, for example.


Default: DetailView of the instance.

Name of the URL to redirect to after creating/updating a review instance.
This could be your review listing, for example.


Avoids multiple reviews by one user, if set to ``True``.


Custom function to check the user's permission. Use a function and note that
the user is the only parameter.

.. code-block:: python

REVIEW_PERMISSION_FUNCTION = lambda u, item: u.get_profile().has_permission(item)


You can limit the period, in which a user is able to update old reviews.
Make sure to use minutes, e.g. 2880 for 48 hours.


You can create your own review form (e.g. if you want to make use of the review
extra info). Just name it.

.. code-block:: python

REVIEW_CUSTOM_FORM = 'myapp.forms.MyCustomReviewForm'

Take a look at the included test app to get an example.


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

.. code-block:: bash

# Fork this repository
# Clone your fork
$ mkvirtualenv -p python2.7 django-review
$ python install
$ pip install -r dev_requirements.txt

$ git co -b feature_branch master
# Implement your feature and tests
$ git add . && git commit
$ git push -u origin feature_branch
# Send us a pull request for your feature branch  
File Type Py Version Uploaded on Size
django-review-1.3.tar.gz (md5) Source 2014-01-03 16KB