A simple Django app to conduct vote.
Project description
## Djnago Vote
django vote is a simple Django app to conduct vote for each model
[![Build Status](https://travis-ci.org/shanbay/django-vote.svg?branch=develop)](https://travis-ci.org/shanbay/django-vote)
### Quick start
#### Install `django-vote` by pip
```shell
pip install django-vote
```
#### Add `'vote'` to your `INSTALLED_APPS` setting like this
```python
INSTALLED_APPS = (
...
'vote',
)
```
#### Run `python manage.py makemigrations vote` to create the vote models.
#### Declare vote field to the model you want to vote
```python
from vote.managers import VotableManager
class ArticleReview(models.Model):
...
votes = VotableManager()
```
#### Use vote API
```python
review = ArticleReview.objects.get(pk=1)
# Adds a new vote to the object
review.votes.up(user_id)
# Removes vote to the object
review.votes.down(user_id)
# Check if the user already voted the object
review.votes.exists(user_id)
# Returns all instances voted by user
Review.votes.all(user_id)
# Returns the number of votes for the object
review.votes.count()
# Returns a list of users who voted and their voting date
review.votes.users()
```
django vote is a simple Django app to conduct vote for each model
[![Build Status](https://travis-ci.org/shanbay/django-vote.svg?branch=develop)](https://travis-ci.org/shanbay/django-vote)
### Quick start
#### Install `django-vote` by pip
```shell
pip install django-vote
```
#### Add `'vote'` to your `INSTALLED_APPS` setting like this
```python
INSTALLED_APPS = (
...
'vote',
)
```
#### Run `python manage.py makemigrations vote` to create the vote models.
#### Declare vote field to the model you want to vote
```python
from vote.managers import VotableManager
class ArticleReview(models.Model):
...
votes = VotableManager()
```
#### Use vote API
```python
review = ArticleReview.objects.get(pk=1)
# Adds a new vote to the object
review.votes.up(user_id)
# Removes vote to the object
review.votes.down(user_id)
# Check if the user already voted the object
review.votes.exists(user_id)
# Returns all instances voted by user
Review.votes.all(user_id)
# Returns the number of votes for the object
review.votes.count()
# Returns a list of users who voted and their voting date
review.votes.users()
```
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
django-vote-2.0.1.tar.gz
(12.1 kB
view hashes)