atlassian-api-py

v0.1.3

Atlassian REST API Python Wrapper.

PyPI

README

GitHub

Apache-2.0

Latest version published 1 month ago

    pip install atlassian-api-py

We couldn't find any similar packages Browse all packages

Package Health Score

72 / 100

Popularity
Small
Maintenance
Sustainable
Security
No known security issues
Community
Sustainable

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Small

Total Weekly Downloads (413)

Dependents: 0
GitHub Stars: 5.42K
Forks: 579
Contributors: 20

The PyPI package atlassian-api-py receives a total of 413 downloads a week. As such, we scored atlassian-api-py popularity level to be Small.

Based on project statistics from the GitHub repository for the PyPI package atlassian-api-py, we found that it has been starred 5,423 times, and that 0 other projects in the ecosystem are dependent on it.

The download numbers shown are the average weekly downloads from the last 6 weeks.

Security

No known security issues

Security and license risk for latest version

Version: 0.1.3 See all versions
Release Date: 02/2021
Direct Vulnerabilities: 0
H

0
M

0
L
Indirect Vulnerabilities: 0
H

0
M

0
L
License Risk: 0
H

2
M

0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Indirect License Risks

atlassian-api-py@0.1.3
- requests@2.25.1
  - certifi@2020.12.5 M

atlassian-api-py@0.1.3
- requests@2.25.1
  - chardet@4.0.0 M

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like atlassian-api-py is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

No Recent Commits

Open Issues: 207
Merged PR: 12
Open PR: 2
Last Commit: 7 months ago

Further analysis of the maintenance status of atlassian-api-py based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that atlassian-api-py demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the atlassian-api-py repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like atlassian-api-py is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Python Versions Compatibility: >=3

Age: 3 months
Latest Release: 1 month ago
Dependencies: 1 Direct / 5 Total
Versions: 21
Maintainers: 1
Wheels: OS Independent

Atlassian REST API Python Wrapper

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

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.

Last updated on 7 March-2021, at 11:57 (UTC).