# Django-Chimps

**Allow users to subscribe to MailChimp email lists.**

# Overview

Django-Chimps provides forms and views to allow users to subscribe to MailChimp emailing lists.

# Requirements

* Python
* Django
* mailsnake (1.6.2)

# Installation

Install using `pip`...

    pip install django-chimps

Add `'chimps'` to your `INSTALLED_APPS` setting.

    INSTALLED_APPS = (
        ...
        'chimps',
    )

Set `MAILCHIMP_KEY` in your settings.

    MAILCHIMP_KEY = '###'

Run `python manage.py chimp_lists` to get a list of mailing lists. Then set `MAILCHIMP_LIST_ID` in your settings.

Include `chimps.urls` in your urlpatterns.

    url(r'^chimps/', include('chimps.urls')),


If you which to have a form on each page, add this to your base template.

    {% load chimp_tags %}

    {% block mailchimp_form %}
        {% chimps_form %}
    {% endblock %}

That's it, we're done!

# Django-Chimps

**Allow users to subscribe to MailChimp email lists.**

[![build-status-image]][travis]

# Overview

Django-Chimps provides forms and views to allow users to subscribe to MailChimp emailing lists.

# Requirements

* Python
* Django
* mailsnake (1.6.2)

# Installation

Install using `pip`...

    pip install django-chimps

Add `'chimps'` to your `INSTALLED_APPS` setting.

    INSTALLED_APPS = (
        ...
        'chimps',
    )

Set `MAILCHIMP_KEY` in your settings.

    MAILCHIMP_KEY = '###'

Run `python manage.py chimp_lists` to get a list of mailing lists. Then set `MAILCHIMP_LIST_ID` in your settings.

Include `chimps.urls` in your urlpatterns.

    url(r'^chimps/', include('chimps.urls')),


If you which to have a form on each page, add this to your base template.

    {% load chimp_tags %}

    {% block mailchimp_form %}
        {% chimps_form %}
    {% endblock %}

That's it, we're done!

[build-status-image]: https://secure.travis-ci.org/simonluijk/django-chimps.png?branch=master
[travis]: http://travis-ci.org/simonluijk/django-chimps?branch=master

Add build status to read me.
Add build status to read me.

Signed-off-by: Simon Luijk <088e16a1019277b15d58faf0541e11910eb756f6@simonluijk.com>
