Python library for interacting with JIRA via REST APIs.
Project description
===================
JIRA Python Library
===================
.. image:: https://img.shields.io/pypi/v/jira.svg
:target: https://pypi.python.org/pypi/jira/
.. image:: https://img.shields.io/pypi/l/jira.svg
:target: https://pypi.python.org/pypi/jira/
.. image:: https://img.shields.io/pypi/wheel/jira.svg
:target: https://pypi.python.org/pypi/jira/
.. image:: https://img.shields.io/github/issues/pycontribs/jira.svg
:target: https://github.com/pycontribs/jira/issues
------------
.. image:: https://readthedocs.org/projects/jira/badge/?version=master
:target: http://jira.readthedocs.io
.. image:: https://travis-ci.com/pycontribs/jira.svg?branch=master
:target: https://travis-ci.com/pycontribs/jira
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/python/black
:alt: Python Black Code Style
.. image:: https://codecov.io/gh/pycontribs/jira/branch/develop/graph/badge.svg
:target: https://codecov.io/gh/pycontribs/jira
.. image:: https://img.shields.io/bountysource/team/pycontribs/activity.svg
:target: https://www.bountysource.com/teams/pycontribs/issues?tracker_ids=3650997
.. image:: https://requires.io/github/pycontribs/jira/requirements.svg?branch=master
:target: https://requires.io/github/pycontribs/jira/requirements/?branch=master
:alt: 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.
.. _BountySource: https://www.bountysource.com/teams/pycontribs/issues?tracker_ids=3650997
Quickstart
----------
Feeling impatient? I like your style.
.. code-block:: python
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,testing]``
.. _virtualenv: http://www.virtualenv.org/en/latest/index.html
Usage
-----
See the documentation_ for full details.
.. _documentation: http://jira.readthedocs.org/en/latest/
Development
-----------
Development takes place on GitHub_:
* ``master`` - (default branch) contains the primary development stream. Tags will be used to show latest releases.
.. _GitHub: https://github.com/pycontribs/jira
Setup
=====
* Fork_ repo
* Keep it sync_'ed while you are developing
* Install pyenv_
* Install `Atlassian JIRA Server`_ for testing
- make install-sdk
* pip install -r requirements-dev.txt
* Start up Jira Server
- atlas-run-standalone
* Test your changes
- make test
.. _Fork: https://help.github.com/articles/fork-a-repo/
.. _sync: https://help.github.com/articles/syncing-a-fork/
.. _pyenv: https://amaral.northwestern.edu/resources/guides/pyenv-tutorial
.. _`Atlassian JIRA Server`: https://www.atlassian.com/software/jira/download
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.
.. _Atlassian: https://www.atlassian.com/
.. _JIRA: https://pycontribs.atlassian.net
.. _JetBrains: http://www.jetbrains.com
.. _PyCharm: http://www.jetbrains.com/pycharm/
.. _Travis: https://travis-ci.org/
.. _navicat: https://www.navicat.com/
.. image:: https://raw.githubusercontent.com/pycontribs/resources/master/logos/x32/logo-atlassian.png
:target: http://www.atlassian.com
.. image:: https://raw.githubusercontent.com/pycontribs/resources/master/logos/x32/logo-pycharm.png
:target: http://www.jetbrains.com/
.. image:: https://raw.githubusercontent.com/pycontribs/resources/master/logos/x32/logo-navicat.png
:target: http://www.navicat.com/
Release history Release notifications | RSS feed
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.0.0a0.tar.gz
(125.5 kB
view hashes)
Built Distribution
Close
Hashes for jira-3.0.0.0a0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7b34b52e6676a7ef4ee88fc243a1aba8000febc6069f67bfcbbc978f9fb19258 |
|
| MD5 | 7d31dd29a39471b415269792b10d6fda |
|
| BLAKE2b-256 | c39c6ffabcce86b349e1d4ef74a14e2e1209746e7067ee195645bfb07ff74b1a |
