atlassian-api-py 0.2.8

Atlassian REST API Python Wrapper.

Atlassian REST API Python Wrapper

What is this?

This package is a wrapper of Atlassian Rest APIs written in Python, currently it supports Atlassian products: JIRA and Bitbucket.

This API package was created to bring ease of implementation for integration with JIRA and Bitbucket.

QuickStart

>>> from atlassian import Jira

>>> jira = Jira(url='https://jira.company.com', username="username", password="password")
>>> issue = jira.issue('TEST-1')
>>> print(issue.fields.status.name)
Triage
>>> print(issue.fields.description)
this is a demo jira ticket
>>> print(issue.fields.status.name)
Triage
>>> print(issue.fields.issuetype.name)
Bug

Save your username and password in a configuration file config.ini, for example:

[jira]
url = https://jira.company.com
username = username
password = password

Then get the credential information though the configuration file config.ini

>>> import configparser
>>> config = configparser.ConfigParser()
>>> config.read('config.ini')

>>> jira_url = config['jira']['url']
>>> jira_usr = config['jira']['username']
>>> jira_psw = config['jira']['password']

>>> jira = Jira(url=jira_url, username=jira_usr, password=jira_psw)
>>> issue = jira.issue('TEST-1')
>>> print(issue.fields.status.name)
Triage
>>> print(issue.fields.description)
this is a demo jira ticket
>>> print(issue.fields.status.name)
Triage
>>> print(issue.fields.issuetype.name)
Bug

Install from PyPI

# install
$ pip install atlassian-api-py

# upgrade to latest
$ pip install atlassian-api-py --upgrade

Unittest and Coverage

Run unittest

cd tests
python -m unittest

Run coverage

cd tests
coverage run -m unittest
coverage report -m              # to report on the results
coverage html                   # to get annotated HTML

FAQ

Q1: Which Jira/BitBucket version I used to develop?

For Jira I used Jira v8.5.9 and Jira Cloud.

For BitBucket I used Bitbucket v5.13.1. not support Bitbucket cloud for now.

Q2: Are there any major changes?

From v0.2.0 (3/9/2021), convert get JIra API data from dict to object, no longer compatible with past old versions.