https://github.com/studioj/jira-agile-toolbox

A python package which extends the jira package with agile related functionality
https://github.com/studioj/jira-agile-toolbox

Last synced: 11 months ago
JSON representation

A python package which extends the jira package with agile related functionality

• Host: GitHub
• URL: https://github.com/studioj/jira-agile-toolbox
• Owner: studioj
• License: mit
• Created: 2021-03-19T12:13:14.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-05-16T20:19:13.000Z (about 3 years ago)
• Last Synced: 2025-04-11T10:01:07.761Z (about 1 year ago)
• Language: Python
• Size: 43.9 KB
• Stars: 3
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.MD

Awesome Lists containing this project

README

          
# jira_agile_toolbox

![python package workflow](https://github.com/studioj/jira-agile-toolbox/actions/workflows/python-publish.yml/badge.svg)

![python package workflow](https://github.com/studioj/jira-agile-toolbox/actions/workflows/python-package.yml/badge.svg)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=studioj_jira-agile-toolbox&metric=alert_status)](https://sonarcloud.io/dashboard?id=studioj_jira-agile-toolbox)



[![PyPI downloads](https://img.shields.io/pypi/dm/jira-agile-toolbox.svg)](https://pypistats.org/packages/jira-agile-toolbox)

A python package which extends the jira package with agile related functionality

            For more info about the jira package

            

            - PyPi: https://pypi.org/project/jira/

            - rtd:  https://jira.readthedocs.io/en/latest/

## Installation

```bash

pip install jira-agile-toolbox

```

## Documentation

https://jira-agile-toolbox.readthedocs.io/

## Features

- ### Getting story points from an epic

Example:

```python

>>> from jira_agile_toolbox import JiraAgileToolBox

>>> from jira import JIRA

>>> my_jira_client = JIRA("https://my-jira-server.com", basic_auth=("MYUSERNAME","MYPASSWORD"))

>>> tb = JiraAgileToolBox(my_jira_client)

>>> tb.get_storypoints_from_epic("JAT-001")

{'total': 100, "Reported": 50, "Closed": 50}

```

- ### Ranking a list of epics on top of another one

Example:

```python

>>> from jira_agile_toolbox import JiraAgileToolBox

>>> from jira import JIRA

>>> my_jira_client = JIRA("https://my-jira-server.com", basic_auth=("MYUSERNAME","MYPASSWORD"))

>>> tb = JiraAgileToolBox(my_jira_client)

>>> tb.rank_issues_by_list([my_jira_client.issue("JAT-001"), my_jira_client.issue("JAT-003")], my_jira_client.issue("JAT-005"))

```

will rank issues like:

| original | result |

| -------- | ------ |

| JAT-010 | JAT-010

| JAT-005 | JAT-001

| JAT-003 | JAT-003 

| JAT-002 | JAT-005

| JAT-001 | JAT-002

- ### more explanation and examples can be found here

    

    https://jira-agile-toolbox.readthedocs.io/en/stable/#api-documentation