Skip to main content

Simple application, that provides customizable email form template tag.You can specify form fields and optionally enable dedicated view to render feedback page.

Project description

Quick start

In code

Add feedback to INSTALLED_APPS

INSTALLED_APPS = [
    ...
    'feedback',
    ...
]

Example urlpatterns:

(r'^feedback', include('feedback.urls'))

Synchronize your database models run django syncdb

In templates

Load tags library:

{% load feedback_tags %}

Insert template tag in your template

{% show_feedback [key] %},

where key is feedback form key. Default key value is default.

Requriments

Note that feedback uses ajax form based on jQuery, so you need to include jQuery in your page. You can install it from Google hosting:

<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>

Settings

FEEDBACK_FORMS
Registry for custom feedback forms. See Customize section.
FEEDBACK_FORMS_NAMES
Registry for feedback form names. See Customize section.

Customize

If you want to customize default feedback form, or add your own, you have to create an application with your forms. All feedback forms should be subclasses of feedback.forms.BaseFeedbackForm. Here is an example of custom feedback class:

from django import forms
from feedback.forms import BaseFeedbackForm


class OrderForm(BaseFeedbackForm):
    name = forms.CharField(label=u'Your name', max_length=200)
    email = forms.EmailField(label=u'Your Email', max_length=200)
    phone = forms.CharField(label=u'Phone', max_length=200)
    address = forms.CharField(label=u'Your address', max_length=200)
    date = forms.CharField(label=u'Date and time', max_length=200)
    file = forms.FileField(label=u'Attach the file')

    response = forms.CharField(label=u'Comment', max_length=500,
        widget=forms.Textarea(attrs={'cols':'30', 'rows':'5'}))
    subject = u'Custom order form'

subject attribute appears in email subject.

Then you need to put feedback forms in your settings.py:

FEEDBACK_FORMS - dictionary object, describes feedback forms on your site. Every key-value pair stands for feedback form object. For example:

FEEDBACK_FORMS = {
    'default': 'feedback.forms.FeedbackForm',
    'order': 'mysite.custom_feedback.forms.OrderForm',
}

You can also specify FEEDBACK_FORMS_NAMES option:

FEEDBACK_FORMS_NAMES - dictionary object, that defines the way a feedback form is displayed in Mailing list admin interface. Every key-value pair stands for feedback form object. For example:

FEEDBACK_FORMS_NAMES = {
    'order': 'Online order form',
}

Now we can include {% show_feedback order %} in template and get overriden form.

Custom templates

You can create custom templates if you have custom form class. Application search them by first. Template names are:

feedback/FORM_KEY/feedback.html, feedback/feedback.html
for rendering form itself
feedback/FORM_KEY/thankyou.html, feedback/thankyou.html
for rendering success response
feedback/FORM_KEY/email.txt, feedback/feedback_messages.txt
for rendering email text

Mailing lists

You can specify a mailing list for each feedback form with admin interface. By default messages from all the feedback forms are sent to the emails specified by MANAGERS setting

What’s new

0.4.1 - Option to define humanized form names was added. 0.4.0 - New version. Responses in DB was deleted and mailing lists was added.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
redsolutioncms.django-simple-feedback-0.4.1.tar.gz (12.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page