https://github.com/thecodinghouse/votes
Like Dislike app based on Django Rest Framework
https://github.com/thecodinghouse/votes
Last synced: 11 months ago
JSON representation
Like Dislike app based on Django Rest Framework
- Host: GitHub
- URL: https://github.com/thecodinghouse/votes
- Owner: thecodinghouse
- License: bsd-3-clause
- Created: 2016-03-10T11:58:13.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-09-01T18:34:59.000Z (over 7 years ago)
- Last Synced: 2024-11-01T10:36:02.904Z (over 1 year ago)
- Language: Python
- Size: 43.9 KB
- Stars: 35
- Watchers: 4
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
=============================
DRF Votes
=============================
.. image:: https://badge.fury.io/py/votes.png
:target: https://badge.fury.io/py/votes
DRF Vote is a simple Django Rest Framework app to add ability to like/dislike a model.
Blog
-------------
You can read more about it on my blog_
.. _blog: https://medium.com/tixdo-labs/vote-your-model-with-no-pain-9d7670b65bfd#.5q8jkl7xt.
Quickstart
----------
Note
----------
User must be logged-in to user user-specific apis.
1. Install votes::
pip install votes
2. Add ``'votes'`` to your ``INSTALLED_APPS`` setting like this::
INSTALLED_APPS = (
...
'votes',
)
3. Run ``python manage.py syncdb`` to create the vote models.
4. Declare vote field to the model you want to vote::
from votes.managers import VotableManager
class ArticleReview(models.Model):
...
votes = VotableManager()
5. Include votes url to your urls.py file::
from django.conf.urls import include
from django.conf.urls import url
from votes import urls
urlpatterns += [
url(r'^', include(urls)),
]
=====
DRF Vote
=====
This is extended version of repo django-vote_
.. _django-vote: https://github.com/Beeblio/django-vote
DRF Vote is a simple Django Rest Framework app to add ability to like/dislike a model.
You can read more about it on my blog post_
.. _post: https://medium.com/@3117Jain/vote-your-model-with-no-pain-9d7670b65bfd#.3zttxekr2
=====
How is it different ?
=====
- Modified to work with django rest framework.
- A new feature of disliking an object is added in this version.
APIs
-----------
/votes/up/
==========
Adds a new like or dislike vote to the object
* param: model, id, vote i.e. model=movies&id=359&vote=true
* vote=option[true for up-vote, false for down-vote, None for no-vote]
This api is used for both liking and disliking the object.
Send
vote=true for like
vote=false for dislike
/votes/down/
==========
Removes vote to the object
* param: model, id i.e. model=movies&id=359
/votes/exists/
============
Check if the user already voted the object
* param: model, id i.e. model=movies&id=359
/votes/all/
=========
return all instances voted by user
* param: model, id i.e. model=movies&id=359
/votes/count/
=======
Returns the number of votes for the object
* param: model, id i.e. model=movies&id=359
/votes/users/
=======
Returns a list of users who voted and their voting date
* param: model, id i.e. model=movies&id=359
/votes/likes/
=======
Returns the number of likes and dislikes for the object.
* param: model, id i.e. model=movies&id=359
Running Tests
--------------
Does the code actually work?
::
source /bin/activate
(myenv) $ pip install -r requirements-test.txt
(myenv) $ python runtests.py
Credits
---------
Tools used in rendering this package:
* Cookiecutter_
* `cookiecutter-pypackage`_
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage