Python Wrapper for Atlassian REST API
=====================================
.. start-overview
.. |pypi-version| image:: https://img.shields.io/pypi/v/atlassian-api-py
:target: https://pypi.org/project/atlassian-api-py/
:alt: PyPI
.. |docs-badge| image:: https://readthedocs.org/projects/atlassian-api-py/badge/?version=latest
:target: https://atlassian-api-py.readthedocs.io/
:alt: Documentation
.. |coverage-badge| image:: https://codecov.io/gh/shenxianpeng/atlassian-api-py/graph/badge.svg?token=UE90982FF2
:target: https://codecov.io/gh/shenxianpeng/atlassian-api-py
:alt: Code Coverage
.. |python-version| image:: https://img.shields.io/pypi/pyversions/atlassian-api-py?style=flat-square
:target: https://pypi.org/project/atlassian-api-py
:alt: PyPI - Python Version
.. |sonar-badge| image:: https://sonarcloud.io/api/project_badges/measure?project=shenxianpeng_atlassian-api-py&metric=alert_status
:target: https://sonarcloud.io/summary/new_code?id=shenxianpeng_atlassian-api-py
:alt: Quality Gate Status
.. |downloads-badge| image:: https://img.shields.io/pypi/dw/atlassian-api-py
:alt: PyPI - Downloads
.. |commit-check-badge| image:: https://img.shields.io/badge/commit--check-enabled-brightgreen?logo=Git&logoColor=white
:target: https://github.com/commit-check/commit-check
:alt: Commit Check
|pypi-version| |docs-badge| |coverage-badge| |python-version| |commit-check-badge|
Overview
--------
A Python wrapper for the Atlassian REST API, supporting JIRA, Bitbucket, and Confluence.
It streamlines integration with Atlassian products.
📘 Documentation: `atlassian-api-py.readthedocs.io <https://atlassian-api-py.readthedocs.io/>`_
.. end-overview
.. start-install
Installation
------------
To install the package, run the following command:
.. code-block:: bash
$ pip install atlassian-api-py
To upgrade to the latest version, use:
.. code-block:: bash
$ pip install atlassian-api-py --upgrade
.. end-install
Usage
-----
You can authenticate using either username/password or a personal access token. Credentials can be provided directly or loaded from a configuration file.
Using username and password
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: python
from atlassian import Jira
jira = Jira(url='https://jira.company.com', username="your_username", password="your_password")
Using a token
~~~~~~~~~~~~~
.. code-block:: python
from atlassian import Jira
jira = Jira(url='https://jira.company.com', token="your_token")
Alternatively, load credentials from ``config.ini`` file:
.. code-block:: ini
[jira]
url = https://jira.company.com
username = username
password = password
# Alternatively
token = yourToken
.. code-block:: python
import configparser
config = configparser.ConfigParser()
config.read('config.ini')
jira_url = config['jira']['url']
jira_usr = config['jira']['username']
jira_psw = config['jira']['password']
# Alternatively
jira_token = config['jira']['token']
Jira Usage
~~~~~~~~~~
Getting issue fields
.. code-block:: python
issue = jira.issue("TEST-1")
print(issue.fields.status.name) # e.g. "Triage"
print(issue.fields.description) # e.g. "This is a demo Jira ticket"
print(issue.fields.issuetype.name) # e.g. "Bug"
Get additional issue details
.. code-block:: python
print(issue.id) # e.g. 1684517
print(issue.key) # e.g. "TEST-1"
print(issue.fields.assignee.key) # e.g. "xpshen"
print(issue.fields.summary) # e.g. "Jira REST API Unit Test Example"
More about Jira, Bitbucket, and Confluence API usage can be found in the `documentation <https://atlassian-api-py.readthedocs.io/>`_
.. start-license
License
-------
This project is released under the `MIT License <LICENSE>`_.
.. end-license
Raw data
{
"_id": null,
"home_page": null,
"name": "atlassian-api-py",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "atlassian, jira, bitbucket, confluence, rest, api",
"author": "Xianpeng Shen",
"author_email": "xianpeng.shen@gmail.com",
"download_url": null,
"platform": null,
"description": "Python Wrapper for Atlassian REST API\n=====================================\n\n.. start-overview\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/atlassian-api-py\n :target: https://pypi.org/project/atlassian-api-py/\n :alt: PyPI\n\n.. |docs-badge| image:: https://readthedocs.org/projects/atlassian-api-py/badge/?version=latest\n :target: https://atlassian-api-py.readthedocs.io/\n :alt: Documentation\n\n.. |coverage-badge| image:: https://codecov.io/gh/shenxianpeng/atlassian-api-py/graph/badge.svg?token=UE90982FF2\n :target: https://codecov.io/gh/shenxianpeng/atlassian-api-py\n :alt: Code Coverage\n\n.. |python-version| image:: https://img.shields.io/pypi/pyversions/atlassian-api-py?style=flat-square\n :target: https://pypi.org/project/atlassian-api-py\n :alt: PyPI - Python Version\n\n.. |sonar-badge| image:: https://sonarcloud.io/api/project_badges/measure?project=shenxianpeng_atlassian-api-py&metric=alert_status\n :target: https://sonarcloud.io/summary/new_code?id=shenxianpeng_atlassian-api-py\n :alt: Quality Gate Status\n\n.. |downloads-badge| image:: https://img.shields.io/pypi/dw/atlassian-api-py\n :alt: PyPI - Downloads\n\n.. |commit-check-badge| image:: https://img.shields.io/badge/commit--check-enabled-brightgreen?logo=Git&logoColor=white\n :target: https://github.com/commit-check/commit-check\n :alt: Commit Check\n\n\n|pypi-version| |docs-badge| |coverage-badge| |python-version| |commit-check-badge|\n\nOverview\n--------\n\nA Python wrapper for the Atlassian REST API, supporting JIRA, Bitbucket, and Confluence.\n\nIt streamlines integration with Atlassian products.\n\n\ud83d\udcd8 Documentation: `atlassian-api-py.readthedocs.io <https://atlassian-api-py.readthedocs.io/>`_\n\n.. end-overview\n\n.. start-install\n\nInstallation\n------------\n\nTo install the package, run the following command:\n\n.. code-block:: bash\n\n $ pip install atlassian-api-py\n\nTo upgrade to the latest version, use:\n\n.. code-block:: bash\n\n $ pip install atlassian-api-py --upgrade\n\n.. end-install\n\nUsage\n-----\n\nYou can authenticate using either username/password or a personal access token. Credentials can be provided directly or loaded from a configuration file.\n\nUsing username and password\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: python\n\n from atlassian import Jira\n jira = Jira(url='https://jira.company.com', username=\"your_username\", password=\"your_password\")\n\nUsing a token\n~~~~~~~~~~~~~\n\n.. code-block:: python\n\n from atlassian import Jira\n jira = Jira(url='https://jira.company.com', token=\"your_token\")\n\nAlternatively, load credentials from ``config.ini`` file:\n\n.. code-block:: ini\n\n [jira]\n url = https://jira.company.com\n username = username\n password = password\n # Alternatively\n token = yourToken\n\n.. code-block:: python\n\n import configparser\n config = configparser.ConfigParser()\n config.read('config.ini')\n\n jira_url = config['jira']['url']\n jira_usr = config['jira']['username']\n jira_psw = config['jira']['password']\n # Alternatively\n jira_token = config['jira']['token']\n\nJira Usage\n~~~~~~~~~~\n\nGetting issue fields\n\n.. code-block:: python\n\n issue = jira.issue(\"TEST-1\")\n print(issue.fields.status.name) # e.g. \"Triage\"\n print(issue.fields.description) # e.g. \"This is a demo Jira ticket\"\n print(issue.fields.issuetype.name) # e.g. \"Bug\"\n\nGet additional issue details\n\n.. code-block:: python\n\n print(issue.id) # e.g. 1684517\n print(issue.key) # e.g. \"TEST-1\"\n print(issue.fields.assignee.key) # e.g. \"xpshen\"\n print(issue.fields.summary) # e.g. \"Jira REST API Unit Test Example\"\n\nMore about Jira, Bitbucket, and Confluence API usage can be found in the `documentation <https://atlassian-api-py.readthedocs.io/>`_\n\n.. start-license\n\nLicense\n-------\n\nThis project is released under the `MIT License <LICENSE>`_.\n\n.. end-license\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Python Wrapper for Atlassian REST API",
"version": "0.6.0",
"project_urls": {
"download": "https://pypi.org/project/atlassian-api-py/#files",
"source": "https://github.com/shenxianpeng/atlassian-api-py",
"tracker": "https://github.com/shenxianpeng/atlassian-api-py/issues"
},
"split_keywords": [
"atlassian",
" jira",
" bitbucket",
" confluence",
" rest",
" api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1a09dfde1c0c3bd4216ae830153862b58998bbbf0268136cceba2d052915a811",
"md5": "c4a2d019f09823e9108cbf707aeed3fd",
"sha256": "23c9d2536da937af519a7fb2ac2e2e833f4f9b965b8e9ee0d65e59bc2ae74ac5"
},
"downloads": -1,
"filename": "atlassian_api_py-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4a2d019f09823e9108cbf707aeed3fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 16460,
"upload_time": "2025-08-22T00:46:03",
"upload_time_iso_8601": "2025-08-22T00:46:03.254265Z",
"url": "https://files.pythonhosted.org/packages/1a/09/dfde1c0c3bd4216ae830153862b58998bbbf0268136cceba2d052915a811/atlassian_api_py-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-22 00:46:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shenxianpeng",
"github_project": "atlassian-api-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "atlassian-api-py"
}
JSON
