Python Wrapper for Atlassian REST API

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

Installation

To install the package, run the following command:

$ pip install atlassian-api-py

To upgrade to the latest version, use:

$ pip install atlassian-api-py --upgrade

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

from atlassian import Jira
jira = Jira(url='https://jira.company.com', username="your_username", password="your_password")

Using a token

from atlassian import Jira
jira = Jira(url='https://jira.company.com', token="your_token")

Alternatively, load credentials from config.ini file:

[jira]
url = https://jira.company.com
username = your_username
password = your_password
# Alternatively
token = your_token

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

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

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

License

This project is released under the MIT License.