This package is used to provide a simple python interface for interacting with Atlassian products (Server, Data Center and Cloud) and apps from ecosystem (Portfolio, XRay). It is based on the official public Rest API documentation and private methods (+ xml+rpc, raw http request).
From PyPI
$ pip install atlassian-python-apiFrom Source
- Git clone repository
- Use
pip install -r requirements.txtto 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:
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)And here's another example of how to get issues from Jira using JQL Query:
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
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:
from atlassian import ServiceDesk
sd = ServiceDesk(
url='http://localhost:7990',
username='admin',
password='admin')
data = sd.get_my_customer_requests()
print(data)Using Xray (Test Management tool for Jira):
from atlassian import Xray
xr = Xray(
url='http://localhost:7990',
username='admin',
password='admin')
data = xr.get_tests('TEST-001')
print(data)If you want to see the response in pretty print format JSON. Feel free for use construction like:
from pprint import pprint
# you code here
# and then print using pprint(result) instead of print(result)
pprint(response)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: