用于获取或设置github提交状态的命令行应用程序。
ghstat的Python项目详细描述
简介
此命令行应用程序主要用于连续构建和 集成环境。它允许提供所有的细节 标记提交状态所必需的。对于拉取请求,它 可以用可选的 指向CI生成服务器的超链接,以及 生成失败。
这是使用github v3 api完成的。
这不是一个很严肃的计划,没有任何推进的计划 更进一步。它是因为现有的GITHUB Python客户端而编写的。 像pygithub3这样的包不提供通信能力 使用“statuses”api端点,最好提供 生成脚本中可读性好的命令行参数 直接卷曲。
安装
此软件包的稳定版本在pypi上维护,使用pip安装:
pip install ghstat
生成个人访问令牌,https://github.com/settings/applications, 启用作用域repo:status和public\u repo或private\u repo。
将此标记用于–token参数,或用作环境变量GITHUB_APP_TOKEN
示例
在github.com上生成失败:
ghstat.py set --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \ --commit 72b74be0de46392a05d8f470b64272b8036e63f8 \ --user jquast --repo ghstat --state success
将提交状态作为json数据检索到stdout:
ghstat.py get --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \ --commit 72b74be0de46392a05d8f470b64272b8036e63f8 \ --user jquast --repo ghstat
链接到私人竹子和GitHub企业帐户:
ghstat.py set --token 0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d \ --commit 0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a0a \ --user jquast \ --repo ghstat \ --state success \ --description 'build successful' \ --target-url 'https://bamboo.mycorp.com/browse/PROJ-BUILD10-1' \ --base-url 'https://github.mycorp.com/api/v3/'
其他
githubdate:同样,它只使用.ini文件而不是命令行参数。
变化
- 0.3.1
- 新的api参数,–context=“ci/teamcity”到distinguish multiple sources。 由PR 3中的@kad贡献
- 0.3.0
- 对于长度大于140的描述,截断并发出警告 标准误差。将改为以文本结尾的长度140 标记“`(…)`”。
- 0.2.0
- 支持Python3
- 支持令牌作为环境值GITHUB_APP_TOKEN
- 在检索不带任何提交的状态时解析索引器错误。
- 0.1.0
- PYPI的初始版本