用于mailchimp api的python包装的appknox fork
ak-postmonke的Python项目详细描述
PostMonkey 1.0b
PostMonkey
是mailchimp的api的一个简单的python(2.6+)包装器
版本1.3。
功能
- 100%测试覆盖率
- 通过优秀的Requests库进行连接处理
- 可配置超时
- 简单的
Exceptions
安装
您可以通过easy_install
:
easy_install postmonkey
或者使用pip
(需要指定版本,因为最新版本是1.0b):
pip install postmonkey==1.0b
或者将需求放在install_requires
文件中:
install_requires=[# all your other packages'postmonkey==1.0b',]
基本用法
一旦用mailcimp api密钥创建了一个PostMonkey
实例,
您可以使用它直接调用mailchimp的api方法:
frompostmonkeyimportPostMonkeypm=PostMonkey('your_api_key')pm.ping()# returns u"Everything's Chimpy!"
如果mailchimp方法调用接受参数,则可以以 关键字参数的。有关常见用例,请参见Examples,并参考 MailChimp API v1.3 official documentation对于方法调用的完整列表, 参数和响应对象。
MailChimp已经为API的使用制定了指导方针/限制,请参考 他们的FAQ信息。
note:调用方负责提供有效的方法名和任何
必需的参数。如果MailChimp收到无效请求,PostMonkey
将引发包含
错误代码和消息。有关其他信息,请参见MailChimp API v1.3 - Exceptions
细节。
示例
创建新的PostMonkey
实例,请求超时10秒:
frompostmonkeyimportPostMonkeypm=PostMonkey('your_api_key',timeout=10)
获取活动列表的ID:
lists=pm.lists()# print the ID and name of each listforlistinlists['data']:printlist['id'],list['name']
订阅“emailaddress”至列表ID 5:
pm.listSubscribe(id=5,email_address="emailaddress")
捕获MailChimp返回的异常(无效列表ID):
frompostmonkeyimportMailChimpExceptiontry:pm.listSubscribe(id=42,email_address="emailaddress")exceptMailChimpException,e:printe.code# 200printe.error# u'Invalid MailChimp List ID: 42'
获取所有“已发送”活动的活动数据:
campaigns=pm.campaigns(filters=[{'status':'sent'}])# print the name and count of emails sent for each campaignforcincampaigns['data']:printc['title'],c['emails_sent']
变更日志
-初始版本
-2012-10-11:发送post请求前引用json字符串
-2013-07-03:文档更新和版本凹凸(无代码更改)