Atlassian REST API Python Wrapper.
Project description
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
More fields
>>> print(issue.id)
1684517
>>> print(issue.key)
TEST-1
>>> print(issue.fields.assignee.key)
xpshen
>>> print(issue.fields.summary)
Jira REST API Unit Test Example
>>> ...
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
Changelog
Track some minor
and micro
changes.
- 0.3.15 - Sep 9, 2021 - Fixed permission issue temporarily by changing file_handler to console_handler.
- 0.3.14 - Sep 9, 2021 - Fixed Permission denied: 'logs' issue.
- 0.3.13 - Sep 8, 2021 - Added
create_issue
in Jira. - 0.3.12 - Sep 2, 2021 - Added u
:
in Jira. - 0.3.11 - Aug 25, 2021 - Added
get_pull_request_comments
in Bitbucket. - 0.3.9 - Aug 19, 2021 - Changed
search_issue_with_sql
tosearch_issue_with_jql
. - 0.3.8 - Aug 19, 2021 - Changed
update_custom_field
to support pass 3 or 4 params in Jira. - 0.3.7 - June 9, 2021 - Added
update_build_status
in Bitbucket. - 0.3.6 - June 9, 2021 - Added
get_build_status
in Bitbucket. - 0.3.5 - June 8, 2021 - Added
update_custom_field
in Jira . - 0.3.3 - June 4, 2021 - Added
get_file_content
in Bitbucket . - 0.3.0 - May 9, 2021 - Fixed Bitbucket and test_bitbucket issues.
- 0.2.7 - Apr 20, 2021 - Added create task with components in Jira.
- 0.2.5 - Apr 20, 2021 - Added
update_issue_component
in Jira . - 0.2.4 - Mar 28, 2021 - Added create_task and refactor code for Jira.
- 0.2.0 - Mar 9, 2021 - Changed API return from JSON data to Python object.
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 0.2.0 - Mar 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.3.16-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc08c193ab44e0d08e48e89ad4c01ebad10d6eeff54616a7ab81dd43317aa624 |
|
MD5 | cdb4d3ce089def017eeabb06a27c3102 |
|
BLAKE2b-256 | 948f0c8577fee3f74e2cb7d56fd0a7612141e6e536ce9ceec6aae53020d06cca |