objectrocket python客户端
objectrocket的Python项目详细描述
objectrocket python客户端
面向python的objectrocket api接口库。
注意:此客户端仍处于开发的初始阶段,随着开发的继续,某些公共接口可能会发生更改。一旦到这个库的公共接口被认为是稳定的,我们将把这个包的版本增加到1.0.0。
示例
要使用库,只需执行以下操作:
>>>importobjectrocket>>>client=objectrocket.Client()>>>client.authenticate('<username>','<password>')# Create a new instance.>>>client.instances.create(name='instance0',size=5,zone='US-West'<MongodbInstance{...}at0x10aedb990># Get an instances object.>>>client.instances.get('instance0')<MongodbInstance{...}at0x10aedb980># Get all instances.>>>client.instances.all()[<MongodbInstance{...}at0x10aedb980>]
安装
pip install objectrocket
发展
测试
在本地测试时,您需要导出几个环境变量:
exportOR_DEFAULT_API_URL='http://localhost:5050/v2/'exportOR_DEFAULT_ADMIN_API_URL='http://localhost:5050/admin/'
在推送代码之前,请从顶层目录运行tox
。如果有错误
报告,修复它们。
覆盖范围
要接收测试覆盖率报告,请从顶层目录运行tox -e coverage
。
PYPI构建
在setup.py中更新版本
按模式/^[0-9]+.[0-9]+.[0-9]+$/
推送标记将自动触发要生成并上载到pypi的客户端的新版本。一个/^[0-9]+.[0-9]+.[0-9]+-rc[0-9]+$/
模式将导致它被推到testpypi。
文档
要构建文档,请从顶层目录调用tox -e docs
。
html索引可以在docs/build/html/index.html
找到。