Metadata-Version: 1.0
Name: mailsnake
Version: 1.6.0
Summary: MailChimp API v1.3, STS, Export, Mandrill wrapper for Python.
Home-page: https://github.com/michaelhelmick/python-mailsnake
Author: John-Kim Murphy
Author-email: UNKNOWN
License: UNKNOWN
Download-URL: http://pypi.python.org/pypi/mailsnake/
Description: MailSnake
        =========
        
        ``MailSnake`` is a Python wrapper for `MailChimp API 1.3 <http://www.mailchimp.com/api/1.3/>`_ (as well as the `STS API <http://apidocs.mailchimp.com/sts/1.0/>`_, `Export API <http://apidocs.mailchimp.com/export/>`_, and `Mandrill API <http://mandrillapp.com/api/docs/>`_) (Now with support for Python 3)
        
        Installation
        ------------
        ::
        
            pip install mailsnake
        
        Usage
        -----
        
        Basic Ping
        ~~~~~~~~~~
        
        ::
        
            from mailsnake import MailSnake
            from mailsnake.exceptions import *
            
            ms = MailSnake('YOUR MAILCHIMP API KEY')
            try:
                ms.ping() # returns "Everything's Chimpy!"
            except MailSnakeException:
                print 'An error occurred. :('
        
        Mandrill Ping
        ~~~~~~~~~~~~~
        
        ::
        
            mapi = MailSnake('YOUR MANDRILL API KEY', api='mandrill')
            mapi.users.ping() # returns "PONG!"
        
        
        STS Example
        ~~~~~~~~~~~
        
        ::
        
            mcsts = MailSnake('YOUR MAILCHIMP API KEY', api='sts')
            mcsts.GetSendQuota() # returns something like {'Max24HourSend': '10000.0', 'SentLast24Hours': '0.0', 'MaxSendRate': '5.0'}
        
        
        Catching Errors
        ~~~~~~~~~~~~~~~
        
        ::
        
            ms = MailSnake( 'my_wrong_mailchimp_api_key_that_does_not_exist')
            try:
                ms.ping() # returns "Everything's Chimpy!"
            except InvalidApiKeyException:
                print 'You have a bad API key, sorry.'
        
        Note
        ----
        
        API parameters must be passed by name. For example:
        
        ::
        
            ms.listMemberInfo(id='YOUR LIST ID', email_address='name@email.com')
        
Keywords: mailsnake mailchimp api wrapper export mandrill sts 1.3 p3k
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
