中文名称：蟒蛇客户端
circleclient的Python项目详细描述
用于Circleci API的Python客户端库。
功能
- 检索有关用户的信息
- 列出遵循的存储库
- 返回给定项目的最近生成的状态
- 开始构建
- 创建参数化生成
- 列出生成工件
- 取消生成
- 重试生成
- 清除生成缓存
安装
pipinstallcircleclient
用法
检索有关用户
的信息importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(token)# Retrieve User dataclient.user.info()
列出用户关注的项目
importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(token)# Retrieve information about projectsclient.projects.list_projects()
触发新版本
importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(token)# Trigger buildclient.build.trigger('<username>','<project_name>','<branch>')
触发新的参数化构建
importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(token)# Trigger parametrized buildclient.build.trigger('<username>','<project_name>','<branch>','<PARAM1>'='<VAL1>')
取消运行生成
importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(token)# Cancel buildclient.build.cancel('<username>','<project_name>','<build_number>')
重试生成
importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(token)# Retry buildclient.build.retry('<username>','<project_name>','<build_number>')
列出构建工件
importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(token)# List build artifactsclient.build.artifacts('<username>','<project_name>','<build_number>')
检索生成状态
importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(token)# Retrieve build statusclient.build.status('<username>','<project_name>','<build_number>')
检索所有项目中有关生成的信息
importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(token)# Retrieve build status# Default limit=30, offset=0client.build.recent_all_projects(limit=<int>,offset=0)client.build.recent_all_projects()
检索有关最近生成的信息
importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(token)# Retrieve build status# Default limit=30, offset=0, branch=Noneclient.build.recent('<username>','<project>',limit='<int>',offset='<int>')# Retrieve last 10 builds of branch masterclient.build.recent('<username>','<project>',limit=10,branch='master')# Retrieve last build of branch developclient.build.recent('<username>','<project>',branch='develop')
检索有关最近生成的已筛选信息
importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(token)# Retrieve build status and filter resultsclient.build.recent('<username>','<project>',branch='master',status_filter='completed')client.build.recent('<username>','<project>',branch='develop',status_filter='successful')client.build.recent('<username>','<project>',limit=10,status_filter='failed')client.build.recent('<username>','<project>',status_filter='running')
清除生成缓存
importosfromcircleclientimportcircleclienttoken=os.environ['API_TOKEN']client=circleclient.CircleClient(api_token=token)# Clear build cacheclient.cache.clear(username='<username>',project='<project_name>')
文件
完整的文档位于http://circleclient.rtfd.org。
历史
0.1.6（2015-09-04）
- 更新的文档
0.1.5（2015-31-03）
- 按生成状态筛选最近的生成：已完成、成功、失败、正在运行
0.1.4（2014-21-09）
- 正在检索有关单个和多个生成的信息。
- 检索具有可选偏移量的有限生成数。
- 正在检索有关特定分支的生成信息。
0.1.3（2014-25-07）
- 添加对参数化生成的支持
- 添加对列出生成工件的支持
0.1.2（2014-07-07）
- 添加对清除缓存的支持
0.1.1（2014-30-06）
- 添加对重试生成的支持
0.1.0（2014-29-06）
- pypi上的第一个版本。
欢迎加入QQ群-->： 979659372
