用于通过REST API与JIRA交互的Python库。
项目描述
这个库简化了从 Python 使用 Jira REST API 的过程,并且已经在生产环境中使用了多年。
由于这是一个由社区维护的开源项目,如果有些错误或功能不能快速实现,请不要感到惊讶。您随时欢迎使用 BountySource 来激励其他人帮助。
快速入门
迫不及待吗?我喜欢你的风格。
from jira import JIRA
jira = JIRA('https://jira.atlassian.com')
issue = jira.issue('JRA-9')
print(issue.fields.project.key) # 'JRA'
print(issue.fields.issuetype.name) # 'New Feature'
print(issue.fields.reporter.displayName) # 'Mike Cannon-Brookes [Atlassian]'
安装
使用 pip install jira 或 easy_install jira 下载并安装
您还可以尝试 pip install --user --upgrade jira,这将安装或升级 jira 到您的用户目录。或者您可能正在使用 virtualenv 吧?
默认情况下,仅安装基本库依赖项,因此如果您想使用 cli 工具或其他可选依赖项,请使用 pip install jira[opt,cli,test] 进行完整安装。
使用方法
请参阅 文档 以获取详细信息。
开发
开发在 GitHub 上进行,使用默认存储库分支。每个版本都有标签。
设置
自动(VS Code)
按照 贡献指南 中的说明操作,该指南将描述如何使用将自动设置合适环境的开发容器。
手动
安装 pyenv 以安装合适的 Python 版本。
- 启动 docker jira 服务器
docker run -dit -p 2990:2990 --name jira addono/jira-software-standalone
tox 环境
- 代码检查
tox -e lint
- 运行测试
tox
- 使用 TWINE 构建和发布
tox -e publish
Jira REST API 参考链接
当更新与 Jira REST API 的交互时,请参考以下文档。我们旨在支持 Jira Cloud 和 Jira Server / Data Center。
Jira Cloud / Jira Server(主要 REST API 参考)
Jira Software Cloud / Jira Software Server(以前的名称包括:Jira Agile,Greenhopper)
鸣谢
除了所有贡献者之外,我们还想感谢以下公司
Atlassian 为开发如此强大的问题跟踪器,并为我们提供了一个免费的按需 Jira 实例,我们可以用它来进行持续集成测试。
GitHub (GitHub) 用于托管我们的持续集成和Git仓库。
Navicat (Navicat) 为我们提供了他们强大的数据库客户端GUI工具的免费许可证。
项目详情
下载文件
下载您平台对应的文件。如果您不确定该选择哪个,请了解有关 安装包 的更多信息。