Skip to main content

Atlassian REST API Python Wrapper.

Project description

Atlassian REST API Python Wrapper

PyPI CodeFactor PyPI - Downloads

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://shenxianpeng.atlassian.net', 
... username="myusername", password="mypassword")
>>> status = jira.get_issue_status('AAP-1')
>>> print(status)
Backlog

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

[jira]
url = https://shenxianpeng.atlassian.net
username = myusername
password = mypassword

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)
>>> status = jira.get_issue_status('AAP-1')
>>> print(status)
Backlog

Install from PyPI

# install
$ pip install atlassian-api-py

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

atlassian_api_py-0.1.0-py3-none-any.whl (10.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page