Jira Python Library
This library eases the use of the Jira REST API from Python and it has been used in production for years.
As this is an open-source project that is community maintained, do not be surprised if some bugs or features are not implemented quickly enough. You are always welcomed to use BountySource to motivate others to help.
Feeling impatient? I like your style.
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]'
Download and install using
pip install jira or
You can also try
pip install --user --upgrade jira which will install or
upgrade jira to your user directory. Or maybe you ARE using a virtualenv
By default only the basic library dependencies are installed, so if you want
to use the
cli tool or other optional dependencies do perform a full
pip install jira[opt,cli,test]
See the documentation for full details.
Development takes place on GitHub using the default repository branch. Each version is tagged.
Automatic (VS Code)
Follow the instructions in the contributing guide, which will describe how to use the dev container that will automatically setup a suitable environment.
- Install pyenv to install a suitable python version.
- Launch docker jira server
docker run -dit -p 2990:2990 --name jira addono/jira-software-standalone
tox -e lint
- Run tests
- Build and publish with TWINE
tox -e publish
Jira REST API Reference Links
When updating interactions with the Jira REST API please refer to the documentation below. We aim to support both Jira Cloud and Jira Server / Data Center.
- Jira Cloud / Jira Server (main REST API reference)
- Jira Software Cloud / Jira Software Server (former names include: Jira Agile, Greenhopper)
- Jira Service Desk Cloud / Jira Service Desk Server
In addition to all the contributors we would like to thank to these companies:
- Atlassian for developing such a powerful issue tracker and for providing a free on-demand Jira instance that we can use for continuous integration testing.
- JetBrains for providing us with free licenses of PyCharm
- GitHub for hosting our continuous integration and our git repo
- Navicat for providing us free licenses of their powerful database client GUI tools.