Git Product home page Git Product logo

django-simple-feedback's Introduction

django-simple-feedback (django-simple-feedback)

image

This Django app has for purpose to integrate easily user based feedback.

It aims to be easily added into existing projects and pretty on any website.

NEW in master
~~~~~~~~~~~~~
master version is now operational for Django-1.3 with collectstatic
This will break backward compatibility, branch django-1.2.5 is the last working

state for Django-1.2.5

Installation

Depedencies

django-simple-feedback requires jQuery, and it includes it in its static files.

Installing django-simple-feedback ~~~~~~~~~~~~~~~~~~~~~~~~~~

Install into your python path using pip or github version:

pip install django-simple-feedback
pip install -e git://github.com/Narsil/django-simple-feedback

Add 'feedback' to your INSTALLED_APPS in settings.py, also make sure 'django.core.context_processors.request' is in your TEMPLATE_CONTEXT_PROCESSORS:

INSTALLED_APPS = (
    ...
    'feedback',
)
....
TEMPLATE_CONTEXT_PROCESSORS = (
    'django.core.context_processors.request'
)

Add css and javascript in your 'base.html' template (jQuery is optional if you already include it in your project):

<link rel="stylesheet" type="text/css" href="{{ STATIC_URL }}feedback/css/feedback.css" />

<script type="text/javascript" src="{{ STATIC_URL }}feedback/js/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="{{ STATIC_URL }}feedback/js/feedback.js"></script>

And then in templates where you want feedback to appear:

{% load feedback_tags %}
....

{% feedback %}

Add '(r'^feedback', include('feedback.urls')' to your urls:

urlpatterns = patterns( '',
    ....
    (r'^feedback', include('feedback.urls'),
)

Don't forget to run :

./manage.py syncdb

to create the table that is going to receive the feedbacks.

Receiving mail of feedbacks

If you wish to receive mail when someone posts some feedback then you need to configure these which are the defaults:

FEEDBACK_SEND_MAIL = True
FEEDBACK_FROM = '[email protected]'
FEEDBACK_REPLY_TO_USER = True
FEEDBACK_TO = map(lambda x:x[1], settings.MANAGERS) (should be managers emails)
FEEDBACK_SUBJECT = '[feedback] %(path)s'
FEEDBACK_BODY = '%(feedback)s'

In FEEDBACK_SUBJECT and FEEDBACK_BODY you are able to customize the text. each string is formatted with a dict containing information on the feedback. Dict is:

{'id': 42,
 'feedback': 'This is a random comment made by random person',
 'path': 'url the feedback was made on',
 'user': User object,
 'request': request object,  # You can access IP and USER_AGENT via request.
 ...} # You can access any data sent by your form here so you can customize at will
 # By just sending additional field in the form.

Other settings are:

FEEDBACK_ASK_EMAIL = False

Asks user to write his email when it is missing from his account.

django-simple-feedback's People

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.