Simple support/contact form for your Django app
Project description
# django-support-form
[![Build Status](https://travis-ci.org/cbmi/django-support-form.png?branch=master)](https://travis-ci.org/cbmi/django-support-form)
[![Coverage Status](https://coveralls.io/repos/cbmi/django-support-form/badge.png?branch=master)](https://coveralls.io/r/cbmi/django-support-form?branch=master)
Simple contact/support form for Django apps.
## Install
```bash
pip install django-support-form
```
## Setup
Add `supportform` to `INSTALLED_APPS` along with the following Django contrib apps:
```python
INSTALLED_APPS = (
'supportform',
...
)
```
Include the `supportform.urls` in the the `ROOT_URLCONF`:
```python
from django.conf.urls import url, patterns, include
urlpatterns = patterns('',
url(r'^support/', include('supportform.urls')),
...
)
```
## Settings
- `SUPPORT_EMAIL` - The recipient email address the support email will be sent to, e.g. 'support@example.com'. Default is `DEFAULT_FROM_EMAIL` Django setting.
- `SUPPORT_EMAIL_SUBJECT` - Default email subject prepopulated in the support form. Default is 'Support Message'.
- `SUPPORT_WAIT_SEND` - Wait until the email successfully sends. If set to false, the email will be sent in the background (via a thread). Default `True`
## Templates
The templates that come with the django-supportform are functional, but _very_ minimal:
- `supportform/form.html` - Renders the support form omitting the email field is the user is logged in. On submission if the email fails to send, a fallback message will be display to send an email directly to `SUPPORT_EMAIL`.
- Context received:
- `form` - `SupportForm` instance
- `supportform/success.html` - Renders a static success/thank you page. This is the page redirected to after successfully sending a message.
- Context received: (none)
An email template is also provided and can be customized as well:
- `supportform/email_body.txt`
- Context recieved:
- `message` - Left by the user
- `request` - Request object
- `user` - If the message was left by an authenticated user
[![Build Status](https://travis-ci.org/cbmi/django-support-form.png?branch=master)](https://travis-ci.org/cbmi/django-support-form)
[![Coverage Status](https://coveralls.io/repos/cbmi/django-support-form/badge.png?branch=master)](https://coveralls.io/r/cbmi/django-support-form?branch=master)
Simple contact/support form for Django apps.
## Install
```bash
pip install django-support-form
```
## Setup
Add `supportform` to `INSTALLED_APPS` along with the following Django contrib apps:
```python
INSTALLED_APPS = (
'supportform',
...
)
```
Include the `supportform.urls` in the the `ROOT_URLCONF`:
```python
from django.conf.urls import url, patterns, include
urlpatterns = patterns('',
url(r'^support/', include('supportform.urls')),
...
)
```
## Settings
- `SUPPORT_EMAIL` - The recipient email address the support email will be sent to, e.g. 'support@example.com'. Default is `DEFAULT_FROM_EMAIL` Django setting.
- `SUPPORT_EMAIL_SUBJECT` - Default email subject prepopulated in the support form. Default is 'Support Message'.
- `SUPPORT_WAIT_SEND` - Wait until the email successfully sends. If set to false, the email will be sent in the background (via a thread). Default `True`
## Templates
The templates that come with the django-supportform are functional, but _very_ minimal:
- `supportform/form.html` - Renders the support form omitting the email field is the user is logged in. On submission if the email fails to send, a fallback message will be display to send an email directly to `SUPPORT_EMAIL`.
- Context received:
- `form` - `SupportForm` instance
- `supportform/success.html` - Renders a static success/thank you page. This is the page redirected to after successfully sending a message.
- Context received: (none)
An email template is also provided and can be customized as well:
- `supportform/email_body.txt`
- Context recieved:
- `message` - Left by the user
- `request` - Request object
- `user` - If the message was left by an authenticated user
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
Close
Hashes for django-support-form-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff787ac2ea1be05d4b47cc0aea365027f9dd55fb8ef9a57571d4a7acf8cc4059 |
|
MD5 | 1f797e6ece9126aa631eaa447f365396 |
|
BLAKE2b-256 | fbddb8c865f939dbd74d0962e2f270b66baa4890a8b064538f72d5bc0ad44905 |