{"id":13477430,"url":"https://github.com/pycontribs/jira","last_synced_at":"2025-05-13T18:04:58.900Z","repository":{"id":18186896,"uuid":"21303988","full_name":"pycontribs/jira","owner":"pycontribs","description":"Python Jira library. Development chat available on https://matrix.to/#/#pycontribs:matrix.org","archived":false,"fork":false,"pushed_at":"2025-05-05T16:53:49.000Z","size":3638,"stargazers_count":2024,"open_issues_count":190,"forks_count":890,"subscribers_count":80,"default_branch":"main","last_synced_at":"2025-05-05T23:11:52.657Z","etag":null,"topics":["jira","python","python3-only"],"latest_commit_sha":null,"homepage":"https://jira.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pycontribs.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"docs/contributing.rst","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["adehad","ssbarnea"]}},"created_at":"2014-06-28T14:06:53.000Z","updated_at":"2025-05-02T14:07:33.000Z","dependencies_parsed_at":"2023-10-15T16:53:13.516Z","dependency_job_id":"473d6e98-a765-41bb-b864-a958814a1b20","html_url":"https://github.com/pycontribs/jira","commit_stats":{"total_commits":1383,"total_committers":266,"mean_commits":"5.1992481203007515","dds":0.794649313087491,"last_synced_commit":"9900396455e749de7c7ba97801cee024c8c1aeec"},"previous_names":[],"tags_count":85,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pycontribs%2Fjira","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pycontribs%2Fjira/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pycontribs%2Fjira/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pycontribs%2Fjira/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pycontribs","download_url":"https://codeload.github.com/pycontribs/jira/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252590627,"owners_count":21772940,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jira","python","python3-only"],"created_at":"2024-07-31T16:01:42.678Z","updated_at":"2025-05-05T23:12:00.345Z","avatar_url":"https://github.com/pycontribs.png","language":"Python","funding_links":["https://github.com/sponsors/adehad","https://github.com/sponsors/ssbarnea"],"categories":["Python","Communication and Coordination","Coordination and Communication","📦 Modules/Packages","Third-party Web APIs","python"],"sub_categories":["Packages","Integration development"],"readme":"===================\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://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\nWARNING PYPI RELEASE BROKEN -  TEMPORARY FIX\n--------------------------------------------\n\n| Dear users, currently we have an issue releasing to pypi which we are trying to solve as soon as possible.\n| Do know this project is fully funded by volunteer work, we're doing as much as we can with our limited time.\n| Version 3.10.1 fixes a deprecation in the search api of atlassian jira\n| A temporary work around shown below can be used to install the 3.10.1 version of the jira package.\n\n.. code-block:: bash\n\n    pip install git+https://github.com/pycontribs/jira.git@3.10.1\n\nif you don't have git installed on your system or you prefer whl files you can install the 3.10.1 like below.\n\n.. code-block:: bash\n\n    pip install https://github.com/pycontribs/jira/releases/download/3.10.1/jira-3.10.1-py3-none-any.whl\n\nin your requirements.txt or pyproject.toml you can temporarily add this release like so.\n\n.. code-block:: bash\n\n    requests # or any other package in your project\n    https://github.com/pycontribs/jira/releases/download/3.10.1/jira-3.10.1-py3-none-any.whl # please check if pypi releases are ok again here https://pypi.org/project/jira/\n\nsorry for the inconvenience, this message will disappear once the issues are solved.\n\n______\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.\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\u0026message=Open\u0026color=blue\u0026logo=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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpycontribs%2Fjira","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpycontribs%2Fjira","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpycontribs%2Fjira/lists"}