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.

Quickstart

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]'

Installation

Download and install using pip install jira or easy_install jira

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 right?

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 installation using pip install jira[opt,cli,test]

Usage

See the documentation for full details.

Development

Development takes place on GitHub using the default repository branch. Each version is tagged.

Setup

• Fork repo
• Keep it sync'ed while you are developing

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.

Manual

• 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 envs

• Lint

  • tox -e lint

• Run tests

  • tox

• 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.

1. Jira Cloud / Jira Server (main REST API reference)
2. Jira Software Cloud / Jira Software Server (former names include: Jira Agile, Greenhopper)
3. Jira Service Desk Cloud / Jira Service Desk Server

Credits

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.