Skip to main content

Persistable oauth2 Mailchimp backend for Django.

Project description

[![PyPI Version](https://img.shields.io/pypi/v/django-plantains.svg)](https://pypi-hypernode.com/pypi/django-plantains)
[![PyPI Python](https://img.shields.io/pypi/pyversions/django-plantains.svg)](https://pypi-hypernode.com/pypi/django-plantains)
[![PyPI Status](https://img.shields.io/pypi/status/django-plantains.svg)](https://pypi-hypernode.com/pypi/django-plantains)
[![PyPI License](https://img.shields.io/pypi/l/django-plantains.svg)](https://pypi-hypernode.com/pypi/django-plantains)

# Django Plantains

Django plantains creates the ability to persist the association of a MailChimp account to an AuthUser account in Django. Leveraging the Django framework this can facitate authentication and persisted storage of Oauth metadata for later retrieval and usage.

# Requirements
Django plantains was built and tested for:
* Django: 1.8
* Python: 2.7

# Installation
Use pip to install into a virtualenv:
```shell
pip install django-plantains
```

In `settings` configuration file add the following:
```python
INSTALLED_APPS = (
...
'plantains',
)
```

Include the application URLconf in your project urls.py:
```python
url(r'^plantains/', include('plantains.urls')),
```

Using a MailChimp registered app, set your client_id and client_secret in your `settings` configuration as well:
```python
MAILCHIMP_CLIENT_ID = '123456789'
MAILCHIMP_CLIENT_SECRET = 'a1b2c3d4e5f6789'

# Optional parameters
# Defaults
MAILCHIMP_SUCCESS_REDIRECT_URL = '/'


# These are in case MailChimp decides
# to change it's endpoints
MAILCHIMP_AUTHORIZATION_URL = 'https://login.mailchimp.com/oauth2/authorize'
MAILCHIMP_ACCESS_TOKEN_URL = 'https://login.mailchimp.com/oauth2/token'
```

Use the authentication url to begin the Oauth process in your Django templates.
```html
<a href="{% url 'mailchimp_auth' %}">Feelin Chimpy</a>
```

Once the authentication is complete you can find your access_token in the `mailchimp_user` table.

## How to Contribute
Django-plantains is willing and open to accept all contributions. Take a fork and make a pull-request. If you feel like becoming an active maintainer, please get in touch in becoming a project contributor.

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-plantains-0.2.tar.gz (4.4 kB view details)

Uploaded Source

File details

Details for the file django-plantains-0.2.tar.gz.

File metadata

File hashes

Hashes for django-plantains-0.2.tar.gz
Algorithm Hash digest
SHA256 214f365e78e8fa8bf5a8648ddcf684e1635d52d14b03c29e7abe91afdbd3576e
MD5 c9fb4ba0979ad9d4e88251d32d603fc1
BLAKE2b-256 bf69ace981dc7278ec020cea3cdd761ff5d443a52372307f10886cfc843f8189

See more details on using hashes here.

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