Giter VIP home page Giter VIP logo

postmonkey's Introduction

PostMonkey 1.0b

PostMonkey is a simple Python (2.6+) wrapper for MailChimp's API version 1.3.

Features

  1. 100% test coverage
  2. Connection handling via the excellent Requests library
  3. Configurable timeout
  4. Simple Exceptions

Installation

You can install postmonkey via easy_install:

easy_install postmonkey

Or by using pip (requires you to specify the version because latest is 1.0b):

pip install postmonkey==1.0b

Or by placing the requirement in install_requires in your setup.py file:

install_requires=[
    # all your other packages
    'postmonkey==1.0b',
]

Basic Usage

Once you create a PostMonkey instance with your MailChimp API key, you can use it to call MailChimp's API methods directly:

from postmonkey import PostMonkey
pm = PostMonkey('your_api_key')
pm.ping() # returns u"Everything's Chimpy!"

If the MailChimp method call accepts parameters, you can supply them in the form of keyword arguments. See Examples for common use cases, and refer to the MailChimp API v1.3 official documentation for a complete list of method calls, parameters, and response objects.

MailChimp has established guidelines/limits for API usage, so please refer to their FAQ for information.

Note: it is the caller's responsibility to supply valid method names and any required parameters. If MailChimp receives an invalid request, PostMonkey will raise a postmonkey.exceptions.MailChimpException containing the error code and message. See MailChimp API v1.3 - Exceptions for additional details.

Examples

Create a new PostMonkey instance with a 10 second timeout for requests:

from postmonkey import PostMonkey
pm = PostMonkey('your_api_key', timeout=10)

Get the IDs for your campaign lists:

lists = pm.lists()

# print the ID and name of each list
for list in lists['data']:
    print list['id'], list['name']

Subscribe "emailaddress" to list ID 5:

pm.listSubscribe(id=5, email_address="emailaddress")

Catch an exception returned by MailChimp (invalid list ID):

from postmonkey import MailChimpException
try:
    pm.listSubscribe(id=42, email_address="emailaddress")
except MailChimpException, e:
    print e.code  # 200
    print e.error # u'Invalid MailChimp List ID: 42'

Get campaign data for all "sent" campaigns:

campaigns = pm.campaigns(filters=[{'status': 'sent'}])

# print the name and count of emails sent for each campaign
for c in campaigns['data']:
    print c['title'], c['emails_sent']

postmonkey's People

Contributors

dhhagan avatar ericrasmussen avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

postmonkey's Issues

Not quoted payload values prevent emails with '+' from being subscribed to MailChimp

When trying to subscribe email with '+' character, getting exception:

Traceback (most recent call last):
  File "postmonkey/__init__.py", line 92, in _make_method_call
    decoded = self._deserialize_response(resp.text)
  File "postmonkey/__init__.py", line 125, in _deserialize_response
    self._fail_if_mailchimp_exc(deserialized)
  File "postmonkey/__init__.py", line 140, in _fail_if_mailchimp_exc
    raise MailChimpException(response['code'], response['error'])
MailChimpException: MailChimp error code 502: "Invalid Email Address: test 01@te
st.com"

Please note, that '+' character is just replaced with space, which is obviously invalid.

The same thing happens when trying to get e.g. lists for email with '+' character.

Bool response is not handled correctly.

In [17]: p.listSubscribe(id=lists['data'][0]['id'], email_address='[email protected]')
---------------------------------------------------------------------------
TypeError                                 Traceback (most recent call last)
/../eggs/Django-1.4-py2.7.egg/django/core/management/commands/shell.pyc in <module>()
----> 1 p.listSubscribe(id=lists['data'][0]['id'], email_address='[email protected]')

/../eggs/postmonkey-1.0a2-py2.7.egg/postmonkey/__init__.pyc in _make_method_call(self, methodname, **kwargs)
     90             raise PostRequestError(e)
     91 
---> 92         decoded = self._deserialize_response(resp.text)
     93         return decoded
     94 

/../eggs/postmonkey-1.0a2-py2.7.egg/postmonkey/__init__.pyc in _deserialize_response(self, text)
    123             raise DeserializationError(text)
    124 
--> 125         self._fail_if_mailchimp_exc(deserialized)
    126 
    127         return deserialized

/../eggs/postmonkey-1.0a2-py2.7.egg/postmonkey/__init__.pyc in _fail_if_mailchimp_exc(self, response)
    133         error returned by MailChimp.
    134         """
--> 135         if 'code' in response and 'error' in response:
    136             raise MailChimpException(response['code'], response['error'])
    137 

TypeError: argument of type 'bool' is not iterable

How to handle Merge vars

How does one handle merge vars with this? Mailchimp API is kind of silly in that the merge vars has to be sent not as a dictionary, but as separate keywords, and one can't send the following as a keyword argument due to [ and ].

merge_vars[FNAME] = "FOOBAR"

instead of merge_vars = {"FNAME": "FOOBAR"}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.