goedev
/
django-voice
Archived
1
0
Fork 0
A simple user feedback application for your Django project
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
 
 
 
 
 
Gokmen Gorgen 729d1bb17f fix travis. 8 years ago
demo run 2to3 utility to make sources Python3 compatible 8 years ago
djangovoice remove models.permalink, use python_2_unicode_compatible decorator 8 years ago
requirements use py3 compatible version of qhonuskan-votes 8 years ago
.gitignore ignore database 8 years ago
.travis.yml fix travis. 8 years ago
LICENSE added LICENSE 11 years ago
MANIFEST.in include fixtures. 9 years ago
README.rst Updated readme for deprecated django.contrib.comments content. Fixes #53 8 years ago
setup.py replace file -> open for PYthon3 compatibility 8 years ago

README.rst

============
django-voice
============

.. image:: https://travis-ci.org/gkmngrgn/django-voice.png?branch=develop
:target: https://travis-ci.org/gkmngrgn/django-voice

django-voice integrates user feedback with your Django project. Originally built for Verb (http://verbapp.com).

IMPORTANT: Upgrading to 0.4 from older versions
===============================================
If you upgrade django-voice to 0.4 from older versions, you will take an error about database changing::

DatabaseError at /feedback/

no such column: djangovoice_feedback.email

You have two ways for fixing the problem.

If you want to use South..
---------------------------
Fake the first migration and run the second migration::

python manage.py migrate --fake djangovoice 0001
python manage.py migrate djangovoice

If you don't want to use South..
--------------------------------
Open your SQL shell and add email column to djangovoice_feedback::

python manage.py dbshell

sqlite> ALTER TABLE "djangovoice_feedback" ADD COLUMN "email" varchar(75) NULL;
sqlite> ALTER TABLE "djangovoice_feedback" ADD COLUMN "slug" varchar(10) NULL;

That's it..

Installation and Dependencies
=============================

To satisfy dependencies listed in REQUIREMENTS you can simply run this command:

::

pip install -r requirements.txt


'pip' will automatically download and install dependencies required for django-voice. Next step is activating helper applications to run.

* Activate django's comment system. (https://docs.djangoproject.com/en/dev/ref/contrib/comments/)
* Add django-gravatar (optional) and qhonuskan-votes to your INSTALLED_APPS in settings file.
* Add comments and django-voice to your url configration.
* Create at least one Type and Status either through the admin or fixtures.

After these steps, your INSTALLED_APPS in settings.py must be seen like this:

::

INSTALLED_APPS = (
...
'django.contrib.comments',
'qhonuskan_votes',
'gravatar', # it's optional dependency
'djangovoice'
)

and urls.py like this:

::

urlpatterns = patterns(
...
url(r'^comments/', include('django.contrib.comments.urls')),
url(r'^feedback/', include('djangovoice.urls')))

If you're using Django 1.6> contrib.comments is deprecated and you can use the forked project:
https://github.com/django/django-contrib-comments
Follow those instructions. Of course your urls.py now looks like this:

::

urlpatterns = patterns(
...
url(r'^comments/', include('django_comments.urls')),
url(r'^feedback/', include('djangovoice.urls')))

Remember to create and save at least one Type and Status model instance.

That's all you need to run django-voice.

Settings
========

::

VOICE_ALLOW_ANONYMOUS_USER_SUBMIT (default: False)
Allow anonymous user to submit feedback. Asks for email and marks
the feedback as private to hide the email and prevent spam.

VOICE_BRAND_VIEW (default: 'djangovoice_home')
The view associated with clicking the brand logo in the top left
of the bootstrap navbar.

AUTHORS
=======
DjangoVoice was originally created by Huw Wilkins (http://huwshimi.com/)

Contributors:

* Ross Poulton http://rossp.org/
* Gökmen Görgen http://gokmengorgen.net/
* Mirat Can Bayrak http://miratcan.tumblr.com/
* Simon Ye https://github.com/yesimon