===================
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/github/issues/pycontribs/jira.svg
:target: https://github.com/pycontribs/jira/issues
.. image:: https://img.shields.io/badge/irc-%23pycontribs-blue
:target: irc:///#pycontribs
------------
.. image:: https://readthedocs.org/projects/jira/badge/?version=main
:target: https://jira.readthedocs.io/
.. image:: https://codecov.io/gh/pycontribs/jira/branch/main/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
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,test]``
.. _virtualenv: https://virtualenv.pypa.io/
Usage
-----
See the documentation_ for full details.
.. _documentation: https://jira.readthedocs.org/
Development
-----------
Development takes place on GitHub_ using the default repository branch. Each
version is tagged.
Setup
=====
* Fork_ repo
* Keep it sync_'ed while you are developing
Automatic (VS Code)
```````````````````
.. image:: https://img.shields.io/static/v1?label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode
:target: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/pycontribs/jira
:alt: Open in Remote - Containers
Follow the instructions in the `contributing guide`_, which will describe how to use the dev container
that will automatically setup a suitable environment.
Manual
``````
* Install pyenv_ to install a suitable python version.
* Launch docker jira server
- ``docker run -dit -p 2990:2990 --name jira addono/jira-software-standalone``
tox envs
````````
* Lint
- ``tox -e lint``
* Run tests
- ``tox``
* Build and publish with TWINE
- ``tox -e publish``
.. _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
.. _pytest: https://docs.pytest.org/en/stable/usage.html#specifying-tests-selecting-tests
.. _contributing guide: https://jira.readthedocs.io/contributing.html
Jira REST API Reference Links
=============================
When updating interactions with the Jira REST API please refer to the documentation below. We aim to support both Jira Cloud and Jira Server / Data Center.
1. `Jira Cloud`_ / `Jira Server`_ (main REST API reference)
2. `Jira Software Cloud`_ / `Jira Software Server`_ (former names include: Jira Agile, Greenhopper)
3. `Jira Service Desk Cloud`_ / `Jira Service Desk Server`_
.. _`Jira Cloud`: https://developer.atlassian.com/cloud/jira/platform/rest/v2/
.. _`Jira Server`: https://docs.atlassian.com/software/jira/docs/api/REST/latest/
.. _`Jira Software Cloud`: https://developer.atlassian.com/cloud/jira/software/rest/
.. _`Jira Software Server`: https://docs.atlassian.com/jira-software/REST/latest/
.. _`Jira Service Desk Cloud`: https://docs.atlassian.com/jira-servicedesk/REST/cloud/
.. _`Jira Service Desk Server`: https://docs.atlassian.com/jira-servicedesk/REST/server/
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_
* GitHub_ for hosting our continuous integration and our git repo
* Navicat_ for providing us free licenses of their powerful database client GUI tools.
.. _Atlassian: https://www.atlassian.com/
.. _Jira: https://pycontribs.atlassian.net
.. _JetBrains: https://www.jetbrains.com/
.. _PyCharm: https://www.jetbrains.com/pycharm/
.. _GitHub: https://github.com/pycontribs/jira
.. _Navicat: https://www.navicat.com/
.. image:: https://raw.githubusercontent.com/pycontribs/resources/main/logos/x32/logo-atlassian.png
:target: https://www.atlassian.com/
.. image:: https://raw.githubusercontent.com/pycontribs/resources/main/logos/x32/logo-pycharm.png
:target: https://www.jetbrains.com/
.. image:: https://raw.githubusercontent.com/pycontribs/resources/main/logos/x32/logo-navicat.png
:target: https://www.navicat.com/
Raw data
{
"_id": null,
"home_page": "https://github.com/pycontribs/jira",
"name": "jira",
"maintainer": "Sorin Sbarnea",
"docs_url": "https://pythonhosted.org/jira/",
"requires_python": ">=3.8",
"maintainer_email": "sorin.sbarnea@gmail.com",
"keywords": "api, atlassian, jira, rest, web",
"author": "Ben Speakmon",
"author_email": "ben.speakmon@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/78/b4/557e4c80c0ea12164ffeec0e29372c085bfb263faad53cef5e1455523bec/jira-3.8.0.tar.gz",
"platform": "any",
"description": "===================\nJira Python Library\n===================\n\n.. image:: https://img.shields.io/pypi/v/jira.svg\n :target: https://pypi.python.org/pypi/jira/\n\n.. image:: https://img.shields.io/pypi/l/jira.svg\n :target: https://pypi.python.org/pypi/jira/\n\n.. image:: https://img.shields.io/github/issues/pycontribs/jira.svg\n :target: https://github.com/pycontribs/jira/issues\n\n.. image:: https://img.shields.io/badge/irc-%23pycontribs-blue\n :target: irc:///#pycontribs\n\n------------\n\n.. image:: https://readthedocs.org/projects/jira/badge/?version=main\n :target: https://jira.readthedocs.io/\n\n.. image:: https://codecov.io/gh/pycontribs/jira/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/pycontribs/jira\n\n.. image:: https://img.shields.io/bountysource/team/pycontribs/activity.svg\n :target: https://www.bountysource.com/teams/pycontribs/issues?tracker_ids=3650997\n\n\nThis library eases the use of the Jira REST API from Python and it has been used in production for years.\n\nAs 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.\n\n.. _BountySource: https://www.bountysource.com/teams/pycontribs/issues?tracker_ids=3650997\n\n\nQuickstart\n----------\n\nFeeling impatient? I like your style.\n\n.. code-block:: python\n\n from jira import JIRA\n\n jira = JIRA('https://jira.atlassian.com')\n\n issue = jira.issue('JRA-9')\n print(issue.fields.project.key) # 'JRA'\n print(issue.fields.issuetype.name) # 'New Feature'\n print(issue.fields.reporter.displayName) # 'Mike Cannon-Brookes [Atlassian]'\n\n\nInstallation\n------------\n\nDownload and install using ``pip install jira`` or ``easy_install jira``\n\nYou can also try ``pip install --user --upgrade jira`` which will install or\nupgrade jira to your user directory. Or maybe you ARE using a virtualenv_\nright?\n\nBy default only the basic library dependencies are installed, so if you want\nto use the ``cli`` tool or other optional dependencies do perform a full\ninstallation using ``pip install jira[opt,cli,test]``\n\n.. _virtualenv: https://virtualenv.pypa.io/\n\n\nUsage\n-----\n\nSee the documentation_ for full details.\n\n.. _documentation: https://jira.readthedocs.org/\n\n\nDevelopment\n-----------\n\nDevelopment takes place on GitHub_ using the default repository branch. Each\nversion is tagged.\n\nSetup\n=====\n* Fork_ repo\n* Keep it sync_'ed while you are developing\n\nAutomatic (VS Code)\n```````````````````\n.. image:: https://img.shields.io/static/v1?label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode\n :target: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/pycontribs/jira\n :alt: Open in Remote - Containers\n\nFollow the instructions in the `contributing guide`_, which will describe how to use the dev container\nthat will automatically setup a suitable environment.\n\nManual\n``````\n* Install pyenv_ to install a suitable python version.\n* Launch docker jira server\n - ``docker run -dit -p 2990:2990 --name jira addono/jira-software-standalone``\n\ntox envs\n````````\n* Lint\n - ``tox -e lint``\n* Run tests\n - ``tox``\n* Build and publish with TWINE\n - ``tox -e publish``\n\n.. _Fork: https://help.github.com/articles/fork-a-repo/\n.. _sync: https://help.github.com/articles/syncing-a-fork/\n.. _pyenv: https://amaral.northwestern.edu/resources/guides/pyenv-tutorial\n.. _pytest: https://docs.pytest.org/en/stable/usage.html#specifying-tests-selecting-tests\n.. _contributing guide: https://jira.readthedocs.io/contributing.html\n\n\nJira REST API Reference Links\n=============================\n\nWhen updating interactions with the Jira REST API please refer to the documentation below. We aim to support both Jira Cloud and Jira Server / Data Center.\n\n1. `Jira Cloud`_ / `Jira Server`_ (main REST API reference)\n2. `Jira Software Cloud`_ / `Jira Software Server`_ (former names include: Jira Agile, Greenhopper)\n3. `Jira Service Desk Cloud`_ / `Jira Service Desk Server`_\n\n.. _`Jira Cloud`: https://developer.atlassian.com/cloud/jira/platform/rest/v2/\n.. _`Jira Server`: https://docs.atlassian.com/software/jira/docs/api/REST/latest/\n.. _`Jira Software Cloud`: https://developer.atlassian.com/cloud/jira/software/rest/\n.. _`Jira Software Server`: https://docs.atlassian.com/jira-software/REST/latest/\n.. _`Jira Service Desk Cloud`: https://docs.atlassian.com/jira-servicedesk/REST/cloud/\n.. _`Jira Service Desk Server`: https://docs.atlassian.com/jira-servicedesk/REST/server/\n\n\nCredits\n-------\n\nIn addition to all the contributors we would like to thank to these companies:\n\n* 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.\n* JetBrains_ for providing us with free licenses of PyCharm_\n* GitHub_ for hosting our continuous integration and our git repo\n* Navicat_ for providing us free licenses of their powerful database client GUI tools.\n\n.. _Atlassian: https://www.atlassian.com/\n.. _Jira: https://pycontribs.atlassian.net\n.. _JetBrains: https://www.jetbrains.com/\n.. _PyCharm: https://www.jetbrains.com/pycharm/\n.. _GitHub: https://github.com/pycontribs/jira\n.. _Navicat: https://www.navicat.com/\n\n.. image:: https://raw.githubusercontent.com/pycontribs/resources/main/logos/x32/logo-atlassian.png\n :target: https://www.atlassian.com/\n\n.. image:: https://raw.githubusercontent.com/pycontribs/resources/main/logos/x32/logo-pycharm.png\n :target: https://www.jetbrains.com/\n\n.. image:: https://raw.githubusercontent.com/pycontribs/resources/main/logos/x32/logo-navicat.png\n :target: https://www.navicat.com/\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Python library for interacting with JIRA via REST APIs.",
"version": "3.8.0",
"project_urls": {
"Bug Tracker": "https://github.com/pycontribs/jira/issues",
"CI: GitHub Actions": "https://github.com/pycontribs/jira/actions",
"Documentation": "https://jira.readthedocs.io",
"Forum": "https://community.atlassian.com/t5/tag/jira-python/tg-p?sort=recent",
"Homepage": "https://github.com/pycontribs/jira",
"Release Management": "https://github.com/pycontribs/jira/projects",
"Source Code": "https://github.com/pycontribs/jira.git"
},
"split_keywords": [
"api",
" atlassian",
" jira",
" rest",
" web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f52bb617020064261ba31cc965e932943458b7facfd9691ad7f76a2b631f44f",
"md5": "69aa8c13c290e0a020470fcc7c0b1c22",
"sha256": "12190dc84dad00b8a6c0341f7e8a254b0f38785afdec022bd5941e1184a5a3fb"
},
"downloads": -1,
"filename": "jira-3.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "69aa8c13c290e0a020470fcc7c0b1c22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 77505,
"upload_time": "2024-03-25T12:16:59",
"upload_time_iso_8601": "2024-03-25T12:16:59.916047Z",
"url": "https://files.pythonhosted.org/packages/4f/52/bb617020064261ba31cc965e932943458b7facfd9691ad7f76a2b631f44f/jira-3.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "78b4557e4c80c0ea12164ffeec0e29372c085bfb263faad53cef5e1455523bec",
"md5": "6e9fa2e8eaa6ac1b1e6ad9a94e63a0e5",
"sha256": "63719c529a570aaa01c3373dbb5a104dab70381c5be447f6c27f997302fa335a"
},
"downloads": -1,
"filename": "jira-3.8.0.tar.gz",
"has_sig": false,
"md5_digest": "6e9fa2e8eaa6ac1b1e6ad9a94e63a0e5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 102927,
"upload_time": "2024-03-25T12:17:03",
"upload_time_iso_8601": "2024-03-25T12:17:03.287488Z",
"url": "https://files.pythonhosted.org/packages/78/b4/557e4c80c0ea12164ffeec0e29372c085bfb263faad53cef5e1455523bec/jira-3.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 12:17:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pycontribs",
"github_project": "jira",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "jira"
}
JSON
