Atlassian REST API Python Wrapper.
Project description
Atlassian REST API Python Wrapper
This library is a wrapper of Atlassian Rest APIs written by Python, currently only supports JIRA and Bitbucket.
Purpose
Create an easy to use API package that I can use for all the projects when I need CI/CD with JIRA, Bitubket.
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
Put 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
$ 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 recent incompatible updates?
From v0.2.0 (3/9/2021), convert Get JIra API data from dict to object, no longer compatible with past old versions.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for atlassian_api_py-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be58df8f1755a9fcc68e79f08234ff5922b1fcd380ef07f995a1a89d0b3c2979 |
|
MD5 | 2f21d4d5ac282c98427d07a9153221c5 |
|
BLAKE2b-256 | dce8092a39a4b7dcbf50676ce30de8d52b3e92b68e5a1ae7e4bc089bcb5644e8 |