batch-mailchimp 0.0.8

A python client for v3 of MailChimp API, with batch support

A light wrapper around mailchimp3 that makes it easier to use batch operations.

Getting Started

Installation

pip install batch-mailchimp

Usage

This can be used as a drop-in replacement for mailchimp3 – just change the import at the top, and everything should work the same:

from batch_mailchimp import BatchMailChimp as MailChimp

client = MailChimp(
    mc_api='YOUR_API_KEY',
    mc_user='YOUR_USERNAME')

The additional functionality comes when we initialise the client with batch=True:

from batch_mailchimp import BatchMailChimp as MailChimp

batch_client = MailChimp(
    mc_api='YOUR_API_KEY',
    mc_user='YOUR_USERNAME',
    batch=True)

If we do this, operations are stored up in the client, to be run later. For example:

# add John Doe with email [e-mail] to list matching id '123456'
batch_client.lists.members.create(
    '123456', {
        'email_address': '[e-mail]',
        'status': 'subscribed',
        'merge_fields': {
            'FNAME': 'John',
            'LNAME': 'Doe',
        },
    },
)

All new operations will be added to the batch. When we’re ready, we can run all the operations in the batch:

batch = batch_client.run_batch()

We can check the batch’s status using:

batch.status()

API Structure and Endpoints

The API structure and endpoints match that of mailchimp3. You should refer to their documentation for usage.

Support

If you are having issues, please create an issue or submit a pull request.

License

The project is licensed under the MIT License.