1. Installation¶

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

pip install 'jira[cli]'

This will handle installation of the client itself as well as the requirements. The [cli] part installs dependencies for the jirashell binary, and may be omitted if you just need the library.

If you’re going to run the client standalone, we strongly recommend using a virtualenv:

python -m venv jira_python
source jira_python/bin/activate
pip install 'jira[cli]'

or:

python -m venv jira_python
jira_python/bin/pip install 'jira[cli]'

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:

https://pypi.python.org/pypi/jira/

1.1. Dependencies¶

requests - 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 1.3.0.
requests-kerberos - Used to implement Kerberos.
ipython - The IPython enhanced Python interpreter provides the fancy chrome used by Headers.

Installing through pip takes care of these dependencies for you.