Metadata-Version: 1.1
Name: django-plantains
Version: 0.1.1
Summary: Persistable oauth2 Mailchimp backend for Django.
Home-page: https://github.com/avelis/django-plantains/
Author: Andrew Velis
Author-email: andrew.velis@gmail.com
License: BSD
Description: |PyPI Link| |PyPI Status| |PyPI License| # 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:
        
        .. code:: shell
        
            pip install django-plantains
        
        In ``settings`` configuration file add the following:
        
        .. code:: python
        
            INSTALLED_APPS = (
                ...
                'plantains',
            )
        
        Include the application URLconf in your project urls.py:
        
        .. code:: 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:
        
        .. code:: 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.
        
        .. code:: 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.
        
        .. |PyPI Link| image:: https://img.shields.io/pypi/v/django-plantains.svg
           :target: https://pypi.python.org/pypi/django-plantains
        .. |PyPI Status| image:: https://img.shields.io/pypi/status/django-plantains.svg
           :target: https://pypi.python.org/pypi/django-plantains
        .. |PyPI License| image:: https://img.shields.io/pypi/l/django-plantains.svg
           :target: https://pypi.python.org/pypi/django-plantains
        
Keywords: django,mailchimp,oauth2
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Framework :: Django
Classifier: Topic :: Software Development :: Libraries :: Python Modules
