Skip to main content

Django TailorDev Contact A simple contact form for your django projects.

Project description

TailorDev Contact

A customizable contact form for your django projects.

You will find the documentation of this project on [readthedocs](

## Dependencies

For now, Django>=1.5 is the only dependency for this project to run on production, with python>=2.6. Currently, this application is not compatible with python 3.3. We are working on it.

## Installation

To install TailorDev Contact, use pip:

$ pip install django-tailordev-contact

If you intend to test or improve this application, first clone this repository and install the local dependencies:

$ pip install -r requirements/local.txt

## Configuration

Add `td_contact` and its dependencies to your `INSTALLED_APPS`:


Add `td_contact` urls to your project url patterns:

urlpatterns = patterns('',
url(r'^contact/', include('td_contact.urls')),

Set your `td_contact` rules in your ``, by adding something like:

# Contact form
'default': {
'prefix': "[Foo:contact]",
'subject': "General informations",
'to': ('', ''),
'partner': {
'prefix': "[Foo:partner]",
'subject': "Partnership opportunity",
'to': ('', ),
'jobs': {
'prefix': "[Foo:jobs]",
'subject': "Job opportunity",
'to': ('', ),

`TD_CONTACT_FORM_RULES` is a simple dictionary where each key defines a new rule. Each rule is also a dictionary defining the email prefix & subject and the recipient list.

> **Important note** : when a contact form has been successfully filled, the user is redirected to the website home page. Thereby, we use the [django messages framework]( to inform our user of its request status. Remember to enable messages and add something like the following to your base template DOM:

{% if messages %}
<ul class="messages">
{% for message in messages %}
<li data-alert{% if message.tags %} class="message {{ message.tags }}"{% endif %}>
{{ message }}
<a href="#" class="close">&times;</a>
{% endfor %}
{% endif %}

This example works with the [zurb foundation framework]( Feel free to adapt this for your favorite framework.

## Urls

TailorDev Contact form defines 3 urls you may use in your templates:

### `contact_form_rule`

This url has been designed to initialize your form with your own rule, *e.g.*:

{% url 'contact_form_rule' 'jobs' %}

### `user_contact_form_by_slug` and `user_contact_form_by_pk`

Depending on your application, people may want to contact a registered user directly and you want an elegant url to point to. To do so, use the `user_contact_form_by_slug` in your templates, *e.g.*:

{% url 'user_contact_form_by_slug' myuser.slug %}

Alternatively, use the `user_contact_form_by_id` in your templates, like:

{% url 'user_contact_form_by_pk' %}

To use this feature, activate the related option in your ``:


### `contact_form`

This base url points to your contact form. Nothing more to add.

## Templates

### Using the default templates

If you want to use our default templates, feel free to do so. But please note that:

* You should create a base template to inherit from, visible as `_layouts/base.html`
* Your form will appear in a `content` block
* Two partial templates must be customized `contact/partials/contact_recipient.html` and `contact/partials/aside.html`

### Using your own template(s)

The template-to-override used to render the form is visible as `contact/form.html`. The core part of the template may looks like:

<div class="form_wrapper">

<h1>{% trans "Contact" %}</h1>

{% if recipient %}
{% include "contact/partials/contact_recipient.html" %}
{% endif %}

<form action="" method="post" class="custom">
{% csrf_token %}
{% for field in form %}
{% if field.is_hidden %}
{{ field }}
{% else %}
<div class="field_wrapper">
<div class="field{% if field.field.required %} required{% endif %}">
<label {% if field.errors %}class="error"{% endif %}>{{ field.label }}</label>
{{ field }}
{% if field.errors %}
<small class="error">{{ field.errors }}</small>
{% endif %}
{% endif %}
{% endfor %}

<button type="submit" />{% trans "Send message" %}</button>

## Running the Tests

You can run the tests with via:

python test



### Code coverage

To estimate the project coverage:

coverage run --source='td_contact'
coverage report -m

Project details

Download files

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

Source Distribution

django-tailordev-contact-0.5.0.tar.gz (11.3 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page