mailchimp api v3 client
Project description
[](https://coveralls.io/github/vikingco/wingmonkey)
[](https://travis-ci.org/vikingco/wingmonkey)
# wingmonkey
mailchimp api v3 client
mailchimp v3 api reference documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/overview/
### Some usage examples:
#### getting list info
```
from wingmonkey.lists import ListSerializer
list_serializer = ListSerializer()
list_id = 'A_VALID_LIST_ID'
my_list = list_serializer.read(list_id=list_id)
name = my_list.name
total_subscribers = my_list.stats['member_count']
unsubscribe_count = my_list.stats['unsubscribe_count']
```
#### creating new member
```
from wingmonkey.members import Member, MemberSerializer
email_address = 'monkeysee@monkey.do'
merge_fields = {FNAME: 'Ceasar', LNAME: 'Chimp'}
language = 'en'
list_id = 'A_VALID_LIST_ID'
member_to_add = Member(
email_address=email_address,
merge_fields=merge_fields,
language=language,
list_id=list_id
)
member_serializer = MemberSerializer()
newly_added_member = member_serializer.create(list_id=list_id, instance=member_to_add)
```
#### get all members of a list
```
from wingmonkey.async_operations import get_all_members_async
from datetime import datetime, timedelta
list_id = 'A_VALID_LIST_ID'
```
* all members
```
all_list_members = get_all_members_async(list_id=list_id)
```
* all members updated since specific date (take care to use the correct string format for datetime)
```
date_since = datetime.strftime(datetime.now() - timedelta(days=1), '%Y-%m-%dT%H:%M:%S')
extra_params = {'since_last_changed': date_since }
all_updated_members_since_yesterday = get_all_members_async(list_id=list_id, extra_params=extra_params)
```
#### batch update of a large list of members
* This will return a list of corresponding batch operation resources (1 for every 500 members)
http://developer.mailchimp.com/documentation/mailchimp/reference/batches/#create-post_batches
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#create-post_lists_list_id
```
from wingmonkey.async_operations import batch_update_members_async
list_id = 'A_VALID_LIST_ID'
member_list = [A_LIST_OF_MEMBER_INSTANCES]
batch_operation_resource_list = batch_update_members_async(list_id=list_id, member_list=member_list)
```
[](https://travis-ci.org/vikingco/wingmonkey)
# wingmonkey
mailchimp api v3 client
mailchimp v3 api reference documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/overview/
### Some usage examples:
#### getting list info
```
from wingmonkey.lists import ListSerializer
list_serializer = ListSerializer()
list_id = 'A_VALID_LIST_ID'
my_list = list_serializer.read(list_id=list_id)
name = my_list.name
total_subscribers = my_list.stats['member_count']
unsubscribe_count = my_list.stats['unsubscribe_count']
```
#### creating new member
```
from wingmonkey.members import Member, MemberSerializer
email_address = 'monkeysee@monkey.do'
merge_fields = {FNAME: 'Ceasar', LNAME: 'Chimp'}
language = 'en'
list_id = 'A_VALID_LIST_ID'
member_to_add = Member(
email_address=email_address,
merge_fields=merge_fields,
language=language,
list_id=list_id
)
member_serializer = MemberSerializer()
newly_added_member = member_serializer.create(list_id=list_id, instance=member_to_add)
```
#### get all members of a list
```
from wingmonkey.async_operations import get_all_members_async
from datetime import datetime, timedelta
list_id = 'A_VALID_LIST_ID'
```
* all members
```
all_list_members = get_all_members_async(list_id=list_id)
```
* all members updated since specific date (take care to use the correct string format for datetime)
```
date_since = datetime.strftime(datetime.now() - timedelta(days=1), '%Y-%m-%dT%H:%M:%S')
extra_params = {'since_last_changed': date_since }
all_updated_members_since_yesterday = get_all_members_async(list_id=list_id, extra_params=extra_params)
```
#### batch update of a large list of members
* This will return a list of corresponding batch operation resources (1 for every 500 members)
http://developer.mailchimp.com/documentation/mailchimp/reference/batches/#create-post_batches
http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#create-post_lists_list_id
```
from wingmonkey.async_operations import batch_update_members_async
list_id = 'A_VALID_LIST_ID'
member_list = [A_LIST_OF_MEMBER_INSTANCES]
batch_operation_resource_list = batch_update_members_async(list_id=list_id, member_list=member_list)
```
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
wingmonkey-0.1.4.tar.gz
(23.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file wingmonkey-0.1.4.tar.gz.
File metadata
- Download URL: wingmonkey-0.1.4.tar.gz
- Upload date:
- Size: 23.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
17d95f3f705e9261547ae77fe4c67d43afac5f76675ab518827ac8d38dfae071
|
|
| MD5 |
992e648858b4bdaac190c36772e9b072
|
|
| BLAKE2b-256 |
82bb189913753882dc562e96184288bedab2b75a24a9e25ff7dcc6e1c4c684b2
|
File details
Details for the file wingmonkey-0.1.4-py3-none-any.whl.
File metadata
- Download URL: wingmonkey-0.1.4-py3-none-any.whl
- Upload date:
- Size: 36.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f7b5d5627732442e21e67c067c672b8a1ee88d6329e2fb9bb4e115ed0ea2a82e
|
|
| MD5 |
367ec8b75d9d227a0abe0e41da06ff18
|
|
| BLAKE2b-256 |
40eeb1702af56df43eb65e5d6768cbd49b6eaa3b3f1eeea56a109144bdc1e094
|