Skip to main content

Python library for interacting with JIRA via REST APIs.

Project description

https://img.shields.io/pypi/v/jira.svg https://img.shields.io/pypi/l/jira.svg https://img.shields.io/github/issues/pycontribs/jira.svg https://img.shields.io/badge/irc-%23pycontribs-blue
https://readthedocs.org/projects/jira/badge/?version=master https://codecov.io/gh/pycontribs/jira/branch/master/graph/badge.svg https://img.shields.io/bountysource/team/pycontribs/activity.svg 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

  • develop and test
    • Launch docker jira server
      • docker run -dit -p 2990:2990 --name jira addono/jira-software-standalone

    • Lint
      • tox -e lint

    • Run tests
      • tox

    • Run tests for one env only
      • tox -e py37

    • Build and publish with TWINE
      • tox -e publish

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jira-3.0.1.tar.gz (101.7 kB view details)

Uploaded Source

Built Distribution

jira-3.0.1-py3-none-any.whl (61.0 kB view details)

Uploaded Python 3

File details

Details for the file jira-3.0.1.tar.gz.

File metadata

  • Download URL: jira-3.0.1.tar.gz
  • Upload date:
  • Size: 101.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for jira-3.0.1.tar.gz
Algorithm Hash digest
SHA256 5bd8f4199632bf91fcfb4ba25ad2226991d403923b75f7cd2b051b4571492831
MD5 fe8ba6462f379242d69ccf348fb19610
BLAKE2b-256 92845c070e7ead9636876961482777fa3909fbea00e4bf7dc28e2749b3a51aaf

See more details on using hashes here.

File details

Details for the file jira-3.0.1-py3-none-any.whl.

File metadata

  • Download URL: jira-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 61.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for jira-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bc8d1dfeb51eb27ec90b455f2013e675b309dada00095936e65e0459a2f0df84
MD5 07b405847e5315c91793dd101496c803
BLAKE2b-256 1e8ac96675b495b2b17338ec21235b47b2beb72514e93c94033bc6d5037e4e35

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page