{"id":13625651,"url":"https://github.com/atlassian-api/atlassian-python-api","last_synced_at":"2025-05-13T20:22:20.382Z","repository":{"id":16772143,"uuid":"19530263","full_name":"atlassian-api/atlassian-python-api","owner":"atlassian-api","description":"Atlassian Python REST API wrapper","archived":false,"fork":false,"pushed_at":"2024-10-20T11:40:51.000Z","size":2516,"stargazers_count":1358,"open_issues_count":270,"forks_count":664,"subscribers_count":43,"default_branch":"master","last_synced_at":"2024-10-29T11:33:15.497Z","etag":null,"topics":["advanced-roadmaps","api","atlassian","bamboo","bitbucket","confluence","crowd","hacktoberfest","jira","jira-service-desk","portfolio","python","rest","tempo","wrapper","xray"],"latest_commit_sha":null,"homepage":"https://atlassian-python-api.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atlassian-api.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-05-07T10:26:26.000Z","updated_at":"2024-10-29T05:31:43.000Z","dependencies_parsed_at":"2023-11-12T12:37:12.916Z","dependency_job_id":"30505196-f882-46d8-93c6-2e2e1d1f3a2f","html_url":"https://github.com/atlassian-api/atlassian-python-api","commit_stats":{"total_commits":1434,"total_committers":334,"mean_commits":4.293413173652695,"dds":0.8417015341701535,"last_synced_commit":"22c69889261aa742dfc1bf442dea0ce17dad18a0"},"previous_names":[],"tags_count":76,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlassian-api%2Fatlassian-python-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlassian-api%2Fatlassian-python-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlassian-api%2Fatlassian-python-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlassian-api%2Fatlassian-python-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atlassian-api","download_url":"https://codeload.github.com/atlassian-api/atlassian-python-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247918921,"owners_count":21018044,"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":["advanced-roadmaps","api","atlassian","bamboo","bitbucket","confluence","crowd","hacktoberfest","jira","jira-service-desk","portfolio","python","rest","tempo","wrapper","xray"],"created_at":"2024-08-01T21:01:58.863Z","updated_at":"2025-04-08T20:09:15.233Z","avatar_url":"https://github.com/atlassian-api.png","language":"Python","readme":"============================\nAtlassian Python API wrapper\n============================\n|Build Status| |PyPI version| |PyPI - Downloads| |License| |Codacy Badge| |Docs| |Discord|\n\nWhat is it?\n___________\nThe **atlassian-python-api** library provides a **simple** and convenient way to interact with Atlassian products\n(such as Jira Service management, Jira Software, Confluence, Bitbucket and apps Insight, X-Ray) using Python.\nIt is based on the official REST APIs of these products, as well as additional private methods and protocols\n(such as xml+rpc and raw HTTP requests).\nThis library can be used to automate tasks, integrate with other tools and systems,\nand build custom applications that interact with Atlassian products.\nIt supports a wide range of Atlassian products, including Jira, Confluence, Bitbucket, StatusPage and others,\nand is compatible with both Atlassian Server and Cloud instances.\n\nOverall, the **atlassian-python-api** is a useful tool for Python developers who want to work with Atlassian products.\nIt is well-documented and actively maintained, and provides a convenient way to access the full range of\nfunctionality offered by the Atlassian REST APIs.\n\n\nDocumentation\n_____________\n\n`Documentation`_\n\n.. _Documentation: https://atlassian-python-api.readthedocs.io\n\nHow to Install?\n_______________\n\nFrom PyPI\n\n.. code-block:: console\n\n   $ pip install atlassian-python-api\n\nFrom Source\n\n- Git clone repository\n- Use :code:`pip install -r requirements.txt` to install the required packages\n- or :code:`pipenv install \u0026\u0026 pipenv install --dev`\n\nExamples\n________\nMore **examples** in :code:`examples/` directory.\n\nHere's a short example of how to create a Confluence page:\n\n.. code-block:: python\n\n    from atlassian import Confluence\n\n    confluence = Confluence(\n        url='http://localhost:8090',\n        username='admin',\n        password='admin')\n\n    status = confluence.create_page(\n        space='DEMO',\n        title='This is the title',\n        body='This is the body. You can use \u003cstrong\u003eHTML tags\u003c/strong\u003e!')\n\n    print(status)\n\nPlease, note Confluence Cloud need to be used via token parameter.\nAnd here's another example of how to get issues from Jira using JQL Query:\n\n.. code-block:: python\n\n    from atlassian import Jira\n\n    jira = Jira(\n        url='http://localhost:8080',\n        username='admin',\n        password='admin')\n    JQL = 'project = DEMO AND status IN (\"To Do\", \"In Progress\") ORDER BY issuekey'\n    data = jira.jql(JQL)\n    print(data)\n\nThe traditional jql method is deprecated for Jira Cloud users, as Atlassian has transitioned to a nextPageToken-based pagination approach instead of startAt. Use enhanced_jql for improved performance and future compatibility.\n\n.. code-block:: python\n\n    from atlassian import Jira\n\n    jira = Jira(\n        url='https://your-jira-instance.atlassian.net',\n        username='your-email@example.com',\n        password='your-api-token',\n        cloud=True  # Ensure this is set to True for Jira Cloud\n    )\n    JQL = 'project = DEMO AND status IN (\"To Do\", \"In Progress\") ORDER BY issuekey'\n    # Fetch issues using the new enhanced_jql method\n    data = jira.enhanced_jql(JQL)\n    print(data)\n\nAlso, you can use the Bitbucket module e.g. for getting project list\n\n.. code-block:: python\n\n    from atlassian import Bitbucket\n\n    bitbucket = Bitbucket(\n            url='http://localhost:7990',\n            username='admin',\n            password='admin')\n\n    data = bitbucket.project_list()\n    print(data)\n\nNow you can use the Jira Service Desk module. See docs.\nExample to get your requests:\n\n.. code-block:: python\n\n    from atlassian import ServiceDesk\n\n    sd = ServiceDesk(\n            url='http://localhost:7990',\n            username='admin',\n            password='admin')\n\n    data = sd.get_my_customer_requests()\n    print(data)\n\nUsing Insight (CMDB Tool for Jira):\n\n.. code-block:: python\n\n    from atlassian import Insight\n\n    insight = Insight(\n            url='http://localhost:7990',\n            username='admin',\n            password='admin')\n\n    data = insight.get_object(88)\n    print(data)\n\n\nUsing Xray (Test Management tool for Jira):\n\n.. code-block:: python\n\n    from atlassian import Xray\n\n    xr = Xray(\n           url='http://localhost:7990',\n            username='admin',\n            password='admin')\n\n    data = xr.get_tests('TEST-001')\n    print(data)\n\nUsing Bamboo:\n\n.. code-block:: python\n\n    from atlassian import Bamboo\n\n    bamboo = Bamboo(\n            url='http://localhost:6990/bamboo/',\n            token=\"\u003cTOKEN\u003e\")\n\n    data = bamboo.get_elastic_configurations()\n    print(data)\n\nIf you want to see the response in pretty print format JSON. Feel free for use construction like:\n\n.. code-block:: python\n\n    from pprint import pprint\n    # you code here\n    # and then print using pprint(result) instead of print(result)\n    pprint(response)\n\nHow to contribute?\n__________________\nFirst of all, I am happy for any PR requests.\nLet's fork and provide your changes :)\nSee the `Contribution Guidelines for this project`_ for details on how to make changes to this library.\n\n.. _Contribution Guidelines for this project: CONTRIBUTING.rst\n.. |Build Status| image:: https://github.com/atlassian-api/atlassian-python-api/workflows/Test/badge.svg?branch=master\n   :target: https://github.com/atlassian-api/atlassian-python-api/actions?query=workflow%3ATest+branch%3Amaster\n   :alt: Build status\n.. |PyPI version| image:: https://badge.fury.io/py/atlassian-python-api.svg\n   :target: https://badge.fury.io/py/atlassian-python-api\n   :alt: PyPI version\n.. |License| image:: https://img.shields.io/pypi/l/atlassian-python-api.svg\n   :target: https://pypi.python.org/pypi/atlassian-python-api\n   :alt: License\n.. |Codacy Badge| image:: https://app.codacy.com/project/badge/Grade/2cca43995cf041b8b181e2b2ff04cee6\n   :target: https://app.codacy.com/gh/atlassian-api/atlassian-python-api/dashboard\n   :alt: Codacy Badge\n.. |PyPI - Downloads| image:: https://static.pepy.tech/badge/atlassian-python-api/month\n   :alt: PyPI - Downloads\n.. |Docs| image:: https://readthedocs.org/projects/atlassian-python-api/badge/?version=latest\n   :target: https://atlassian-python-api.readthedocs.io/?badge=latest\n   :alt: Documentation Status\n.. |Discord| image:: https://img.shields.io/discord/756142204761669743.svg?label=\u0026logo=discord\u0026logoColor=ffffff\u0026color=7389D8\u0026labelColor=6A7EC2\n   :alt: Discord Chat\n   :target: https://discord.gg/FCJsvqh\n\n\nCredits\n_______\nIn addition to all the contributors we would like to thank these vendors:\n\n* Atlassian_ for developing such a powerful ecosystem.\n* JetBrains_ for providing us with free licenses of PyCharm_\n* Microsoft_ for providing us with free licenses of VSCode_\n* GitHub_ for hosting our repository and continuous integration\n\n.. _Atlassian: https://www.atlassian.com/\n.. _JetBrains: http://www.jetbrains.com\n.. _PyCharm: http://www.jetbrains.com/pycharm/\n.. _GitHub: https://github.com/\n.. _Microsoft: https://github.com/Microsoft/vscode/\n.. _VSCode: https://code.visualstudio.com/\n","funding_links":[],"categories":["Python"],"sub_categories":["Packages"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatlassian-api%2Fatlassian-python-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatlassian-api%2Fatlassian-python-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatlassian-api%2Fatlassian-python-api/lists"}