Yola API 的 Python 客户端
项目描述
用法
# settings file
from yolapy.configuration import configure
configure(
auth=('username', 'password'),
url='https://wl.qa.yola.net/',
)
# application code
from yolapy.models import User as YolaUser
yola_user = YolaUser(
email='test@example.com',
name='Jane',
surname='Doe',
partner_id='WL_YOLA',
preferences={'name': 'value'})
yola_user.save()
有关文档的可用方法,请参见http://yolapy.readthedocs.org/。
发展
要运行测试:
$ nosetests
默认情况下不运行集成测试。要运行它们,您必须设置集成环境并编辑测试设置:
$ cp tests/test_integration/test_settings.py.sample \
tests/test_integration/test_settings.py
注意:尽量不要针对 Yola QA 环境运行测试。它用于手动测试,我们不想将它与在自动测试运行中创建的用户混淆。
然后您可以显式运行集成测试:
$ nosetests tests/test_integration
在您进行更改时自动测试和检查您的代码:
$ cp tube.py.sample tube.py $ stir
要使用您的test_settings初始化的Yola客户端打开 REPL :
$ python -i shell.py
文档
应记录对公共接口的更改。请参阅文档目录。
自动推送到http://yolapy.readthedocs.org/en/latest/的主分支构建 。
您可以使用以下方法在本地测试您的文档更改:
$ cd docs $ make html $ open _build/html/index.html
0.8.0
删除计算Site.is_published属性,因为它已经在 api 中。
0.7.0
添加Yola.set_site_url方法。
0.6.2
使用维护的 python 版本运行测试:2.7、3.5、3.6、3.7、3.8
添加Yola.complete_wl_task(wl_task_id)
添加Yola.fail_wl_task(wl_task_id, reason)
0.6.1
添加Yola.get_user_wsites方法。
0.6.0
去除六个依赖
删除User.save方法
添加User.create类方法
添加Yola.get_sso_url方法
修复Yola服务create_site_import方法 调用签名不正确导致的 bug
更新User.__init__以接受**kwargs而不是命名参数。这使其与其他 yolapy 模型保持一致,并且在服务返回的数据发生更改的情况下更加灵活。
0.5.0
删除Yola.subscribe_to_campaign()和Yola.cancel_campaign_subscription 方法,它们不允许在外部使用。
添加 SiteImport 模型和 api 用于创建和列表
Yola.get_sso_create_site_url和Yola.get_sso_open_site_url 现在接受可选的语言环境参数,这些参数定义了返回的 url 应该生成的语言
0.4.2
删除方法 User.get_sso_create_site_url()和Site.change_site_domain()的with_ssl_support标志。
添加Yola.create_cname_zone()方法。
0.4.1
为方法 User.get_sso_create_site_url()和Site.change_site_domain()添加对with_ssl_support标志的支持。
0.4.0
更新订阅模型以期望来自服务响应的实际数据。
0.3.0
放弃对 python 3.2 的支持
Yola.get_sso_open_site_url现在接受一个可选的site_id指定要生成 url 的站点
使用需求 >= 4.0.0
0.2.4 (2016-06-17)
修复 setup.py 和 requirements.txt 中需求版本不匹配的问题
0.2.3 (2016-06-17)
在 Site.list 中处理分页
添加返回填充的用户对象的User.get类方法
0.2.2 (2016-04-06)
添加Site.is_published
0.2.1 (2016-03-31)
添加站点.list
0.2.0 (2016-03-29)
Yola.create_subscription现在返回创建的订阅。
重大更改:删除Yola.suspend_user和Yola.resume_user。
添加场地模型。
0.1.7 (2015-12-02)
更新订阅模型以包含从 API 返回的所有属性。
0.1.6 (2015-12-01)
更新安装要求(需求)
支持 Python 3
0.1.5 (2015-11-23)
从change_subscription_type和activate_trial_subscription 方法返回值。
修复了失败的集成测试。
0.1.4 (2015-11-19)
添加订阅模型
0.1.3 (2015-10-19)
添加合作伙伴模型
0.1.2 (2015-10-15)
添加配置模块
添加用户模型
添加 Sphinx 文档 - http://yolapy.readthedocs.org/
0.1.1 (2015-09-11)
更新安装要求
0.1.0 (2015-09-02)
带有用于 Yola API 的Yola包装器的初始版本