Python library for interacting with JIRA via REST APIs.


Keywords
api, atlassian, jira, rest, web, python, python3-only
License
BSD-3-Clause
Install
pip install jira==2.0.0

Documentation

JIRA Python Library

https://img.shields.io/badge/irc-%23pycontribs-blue


https://readthedocs.org/projects/jira/badge/?version=master https://travis-ci.com/pycontribs/jira.svg?branch=master Python Black Code Style Requirements Status

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.

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:

  • master - (default branch) contains the primary development stream. Tags will be used to show latest releases.

Setup

  • Fork repo
  • Keep it sync'ed while you are developing
  • Install pyenv
  • Install Atlassian JIRA Server for testing - make install-sdk
  • pip install jira[test]
  • Start up Jira Server - atlas-run-standalone
  • Test your changes - make test

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
  • Travis for hosting our continuous integration
  • Navicat for providing us free licenses of their powerful database client GUI tools.
https://raw.githubusercontent.com/pycontribs/resources/master/logos/x32/logo-atlassian.png https://raw.githubusercontent.com/pycontribs/resources/master/logos/x32/logo-pycharm.png https://raw.githubusercontent.com/pycontribs/resources/master/logos/x32/logo-navicat.png