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.
From PyPI
$ pip install atlassian-python-api
From Source
- Git clone repository
- Use
pip install -r requirements.txt
to install the required packages - or
pipenv install && pipenv install --dev
More examples in examples/
directory.
Here's a short example of how to create a Confluence page:
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:
Also, you can use the Bitbucket module e.g. for getting project list
Now you can use the Jira Service Desk module. See docs. Example to get your requests:
Using Insight (CMDB Tool for Jira):
Using Xray (Test Management tool for Jira):
Using Bamboo:
If you want to see the response in pretty print format JSON. Feel free for use construction like:
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.
In addition to all the contributors we would like to thank these vendors: