Welcome to jira-python’s documentation!

This documents the jira-python package (version 0.48), a Python library designed to ease the use of the JIRA REST API. Some basic support for the GreenHopper REST API also exists.

The source is stored at https://github.com/pycontribs/jira.

Installation

Examples

The easiest (and best) way to install jira-python is through pip:

$ pip install jira

This will handle the client itself as well as the requirements.

If you’re going to run the client standalone, we strongly recommend using a virtualenv, which pip can also set up for you:

$ pip -E jira_python install jira
$ workon jira_python

Doing this creates a private Python “installation” that you can freely upgrade, degrade or break without putting the critical components of your system at risk.

Source packages are also available at PyPI:

Dependencies

Python

Python 2.7 and Python 3.x are both supported.

Requests

Kenneth Reitz’s indispensable python-requests library handles the HTTP business. Usually, the latest version available at time of release is the minimum version required; at this writing, that version is 1.2.0, but any version >= 1.0.0 should work.

requests-oauthlib

Used to implement OAuth. The latest version as of this writing is 0.3.3.

IPython

The IPython enhanced Python interpreter provides the fancy chrome used by Issues. As with Requests, the latest version available at release time is required; at this writing, that’s 0.13.

filemagic

This library handles content-type autodetection for things like image uploads. This will only work on a system that provides libmagic; Mac and Unix will almost always have it preinstalled, but Windows users will have to use Cygwin or compile it natively. If your system doesn’t have libmagic, you’ll have to manually specify the contentType parameter on methods that take an image object, such as project and user avater creation.

tlslite

This is a TLS implementation that handles key signing. It’s used to help implement the OAuth handshaking.

PyCrypto

This is required for the RSA-SHA1 used by OAuth. Please note that it’s not installed automatically, since it’s a fairly cumbersome process in Windows. On Linux and OS X, a pip install pycrypto should do it.

Installing through pip takes care of these dependencies for you.

Contributing

The client is an open source project under the BSD license. Contributions of any kind are welcome!

https://github.com/pycontribs/jira/

If you find a bug or have an idea for a useful feature, file it at that bitbucket project. Extra points for source code patches – fork and send a pull request.

Discussion and support

We encourage all who wish to discuss by using https://answers.atlassian.com/questions/topics/754366/jira-python

Keep in mind to use the jira-python tag when you add a new question. This will assure that the project mantainers will get notified about your question.

Indices and tables