atlassian-python-api


Nameatlassian-python-api JSON
Version 3.41.16 PyPI version JSON
download
home_pagehttps://github.com/atlassian-api/atlassian-python-api
SummaryPython Atlassian REST API Wrapper
upload_time2024-09-16 07:39:21
maintainerGonchik Tsymzhitov
docs_urlNone
authorMatt Harasymczuk
requires_pythonNone
licenseApache License 2.0
keywords atlassian jira core software confluence bitbucket bamboo crowd portfolio tempo servicedesk assets api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ============================
Atlassian Python API wrapper
============================
|Build Status| |PyPI version| |PyPI - Downloads| |License| |Codacy Badge| |Docs| |Discord|

What is it?
___________
The **atlassian-python-api** library provides a **simple** and convenient way to interact with Atlassian products
(such as Jira Service management, Jira Software, Confluence, Bitbucket and apps Insight, X-Ray) using Python.
It is based on the official REST APIs of these products, as well as additional private methods and protocols
(such as xml+rpc and raw HTTP requests).
This library can be used to automate tasks, integrate with other tools and systems,
and build custom applications that interact with Atlassian products.
It supports a wide range of Atlassian products, including Jira, Confluence, Bitbucket, StatusPage and others,
and is compatible with both Atlassian Server and Cloud instances.

Overall, the **atlassian-python-api** is a useful tool for Python developers who want to work with Atlassian products.
It is well-documented and actively maintained, and provides a convenient way to access the full range of
functionality offered by the Atlassian REST APIs.


Documentation
_____________

`Documentation`_

.. _Documentation: https://atlassian-python-api.readthedocs.io

How to Install?
_______________

From PyPI

.. code-block:: console

   $ pip install atlassian-python-api

From Source

- Git clone repository
- Use :code:`pip install -r requirements.txt` to install the required packages
- or :code:`pipenv install && pipenv install --dev`

Examples
________
More **examples** in :code:`examples/` directory.

Here's a short example of how to create a Confluence page:

.. code-block:: python

    from atlassian import Confluence

    confluence = Confluence(
        url='http://localhost:8090',
        username='admin',
        password='admin')

    status = confluence.create_page(
        space='DEMO',
        title='This is the title',
        body='This is the body. You can use <strong>HTML tags</strong>!')

    print(status)

Please, note Confluence Cloud need to be used via token parameter.
And here's another example of how to get issues from Jira using JQL Query:

.. code-block:: python

    from atlassian import Jira

    jira = Jira(
        url='http://localhost:8080',
        username='admin',
        password='admin')
    JQL = 'project = DEMO AND status IN ("To Do", "In Progress") ORDER BY issuekey'
    data = jira.jql(JQL)
    print(data)

Also, you can use the Bitbucket module e.g. for getting project list

.. code-block:: python

    from atlassian import Bitbucket

    bitbucket = Bitbucket(
            url='http://localhost:7990',
            username='admin',
            password='admin')

    data = bitbucket.project_list()
    print(data)

Now you can use the Jira Service Desk module. See docs.
Example to get your requests:

.. code-block:: python

    from atlassian import ServiceDesk

    sd = ServiceDesk(
            url='http://localhost:7990',
            username='admin',
            password='admin')

    data = sd.get_my_customer_requests()
    print(data)

Using Insight (CMDB Tool for Jira):

.. code-block:: python

    from atlassian import Insight

    insight = Insight(
            url='http://localhost:7990',
            username='admin',
            password='admin')

    data = insight.get_object(88)
    print(data)


Using Xray (Test Management tool for Jira):

.. code-block:: python

    from atlassian import Xray

    xr = Xray(
           url='http://localhost:7990',
            username='admin',
            password='admin')

    data = xr.get_tests('TEST-001')
    print(data)

Using Bamboo:

.. code-block:: python

    from atlassian import Bamboo

    bamboo = Bamboo(
            url='http://localhost:6990/bamboo/',
            token="<TOKEN>")

    data = bamboo.get_elastic_configurations()
    print(data)

If you want to see the response in pretty print format JSON. Feel free for use construction like:

.. code-block:: python

    from pprint import pprint
    # you code here
    # and then print using pprint(result) instead of print(result)
    pprint(response)

How to contribute?
__________________
First of all, I am happy for any PR requests.
Let's fork and provide your changes :)
See the `Contribution Guidelines for this project`_ for details on how to make changes to this library.

.. _Contribution Guidelines for this project: CONTRIBUTING.rst
.. |Build Status| image:: https://github.com/atlassian-api/atlassian-python-api/workflows/Test/badge.svg?branch=master
   :target: https://github.com/atlassian-api/atlassian-python-api/actions?query=workflow%3ATest+branch%3Amaster
   :alt: Build status
.. |PyPI version| image:: https://badge.fury.io/py/atlassian-python-api.svg
   :target: https://badge.fury.io/py/atlassian-python-api
   :alt: PyPI version
.. |License| image:: https://img.shields.io/pypi/l/atlassian-python-api.svg
   :target: https://pypi.python.org/pypi/atlassian-python-api
   :alt: License
.. |Codacy Badge| image:: https://app.codacy.com/project/badge/Grade/2cca43995cf041b8b181e2b2ff04cee6
   :target: https://app.codacy.com/gh/atlassian-api/atlassian-python-api/dashboard
   :alt: Codacy Badge
.. |PyPI - Downloads| image:: https://static.pepy.tech/badge/atlassian-python-api/month
   :alt: PyPI - Downloads
.. |Docs| image:: https://readthedocs.org/projects/atlassian-python-api/badge/?version=latest
   :target: https://atlassian-python-api.readthedocs.io/?badge=latest
   :alt: Documentation Status
.. |Discord| image:: https://img.shields.io/discord/756142204761669743.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2
   :alt: Discord Chat
   :target: https://discord.gg/FCJsvqh


Credits
_______
In addition to all the contributors we would like to thank these vendors:

* Atlassian_ for developing such a powerful ecosystem.
* JetBrains_ for providing us with free licenses of PyCharm_
* Microsoft_ for providing us with free licenses of VSCode_
* GitHub_ for hosting our repository and continuous integration

.. _Atlassian: https://www.atlassian.com/
.. _JetBrains: http://www.jetbrains.com
.. _PyCharm: http://www.jetbrains.com/pycharm/
.. _GitHub: https://github.com/
.. _Microsoft: https://github.com/Microsoft/vscode/
.. _VSCode: https://code.visualstudio.com/

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/atlassian-api/atlassian-python-api",
    "name": "atlassian-python-api",
    "maintainer": "Gonchik Tsymzhitov",
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "gonchik.tsymzhitov@gmail.com",
    "keywords": "atlassian jira core software confluence bitbucket bamboo crowd portfolio tempo servicedesk assets api",
    "author": "Matt Harasymczuk",
    "author_email": "matt@astrotech.io",
    "download_url": "https://files.pythonhosted.org/packages/9a/04/15839ae4b60f8f15195a75bf512ab926374832affdbd83463da8edae2b62/atlassian_python_api-3.41.16.tar.gz",
    "platform": "Platform Independent",
    "description": "============================\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 && 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 <strong>HTML tags</strong>!')\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\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=\"<TOKEN>\")\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=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=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",
    "bugtrack_url": null,
    "license": "Apache License 2.0",
    "summary": "Python Atlassian REST API Wrapper",
    "version": "3.41.16",
    "project_urls": {
        "Download": "https://github.com/atlassian-api/atlassian-python-api",
        "Homepage": "https://github.com/atlassian-api/atlassian-python-api"
    },
    "split_keywords": [
        "atlassian",
        "jira",
        "core",
        "software",
        "confluence",
        "bitbucket",
        "bamboo",
        "crowd",
        "portfolio",
        "tempo",
        "servicedesk",
        "assets",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "285b73d6e52274fa35c3a08f62336945b49eedd50aa02c6929f1ed62ae5874c2",
                "md5": "bbbe9762a3cf682c04fbc5eeb90380ca",
                "sha256": "99e5587233a96d22c45a61b19523dd98e8266c620ba2d289f23e4ea35c9cf316"
            },
            "downloads": -1,
            "filename": "atlassian_python_api-3.41.16-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bbbe9762a3cf682c04fbc5eeb90380ca",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 177883,
            "upload_time": "2024-09-16T07:39:18",
            "upload_time_iso_8601": "2024-09-16T07:39:18.559571Z",
            "url": "https://files.pythonhosted.org/packages/28/5b/73d6e52274fa35c3a08f62336945b49eedd50aa02c6929f1ed62ae5874c2/atlassian_python_api-3.41.16-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9a0415839ae4b60f8f15195a75bf512ab926374832affdbd83463da8edae2b62",
                "md5": "57ce299977e47c68f4020bc008bd76fb",
                "sha256": "dc0144ff8b8884562bb2af650586292524ad25f120cd21940df80f0d2ac64411"
            },
            "downloads": -1,
            "filename": "atlassian_python_api-3.41.16.tar.gz",
            "has_sig": false,
            "md5_digest": "57ce299977e47c68f4020bc008bd76fb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 382425,
            "upload_time": "2024-09-16T07:39:21",
            "upload_time_iso_8601": "2024-09-16T07:39:21.035407Z",
            "url": "https://files.pythonhosted.org/packages/9a/04/15839ae4b60f8f15195a75bf512ab926374832affdbd83463da8edae2b62/atlassian_python_api-3.41.16.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-16 07:39:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "atlassian-api",
    "github_project": "atlassian-python-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "tox": true,
    "lcname": "atlassian-python-api"
}
        
Elapsed time: 0.49176s