jira-agile-toolbox


Namejira-agile-toolbox JSON
Version 0.0.15 PyPI version JSON
download
home_pageNone
SummaryExtends standard jira package with agile specific tooling for metrics and administration
upload_time2025-09-13 12:22:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.6
licenseMIT
keywords agile api atlassian jira kanban rest scrum web
VCS
bugtrack_url
requirements jira
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # 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)
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
[![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

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "jira-agile-toolbox",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "agile, api, atlassian, jira, kanban, rest, scrum, web",
    "author": null,
    "author_email": "Jef Neefs <noreply@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/e9/c3/a869e09896e02d787c6f48be624c60e651ecaf86785ab732dda81ff05e23/jira_agile_toolbox-0.0.15.tar.gz",
    "platform": null,
    "description": "# jira_agile_toolbox\n\n![python package workflow](https://github.com/studioj/jira-agile-toolbox/actions/workflows/python-publish.yml/badge.svg)\n![python package workflow](https://github.com/studioj/jira-agile-toolbox/actions/workflows/python-package.yml/badge.svg)\n[![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)\n<a href=\"https://github.com/psf/black\"><img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"></a>\n[![PyPI downloads](https://img.shields.io/pypi/dm/jira-agile-toolbox.svg)](https://pypistats.org/packages/jira-agile-toolbox)\n\n\nA python package which extends the jira package with agile related functionality\n\n            For more info about the jira package\n            \n            - PyPi: https://pypi.org/project/jira/\n            - rtd:  https://jira.readthedocs.io/en/latest/\n\n## Installation\n```bash\npip install jira-agile-toolbox\n```\n\n## Documentation\nhttps://jira-agile-toolbox.readthedocs.io/\n\n## Features\n\n- ### Getting story points from an epic\n\nExample:\n```python\n>>> from jira_agile_toolbox import JiraAgileToolBox\n>>> from jira import JIRA\n>>> my_jira_client = JIRA(\"https://my-jira-server.com\", basic_auth=(\"MYUSERNAME\",\"MYPASSWORD\"))\n>>> tb = JiraAgileToolBox(my_jira_client)\n>>> tb.get_storypoints_from_epic(\"JAT-001\")\n{'total': 100, \"Reported\": 50, \"Closed\": 50}\n```\n\n- ### Ranking a list of epics on top of another one\n\nExample:\n```python\n>>> from jira_agile_toolbox import JiraAgileToolBox\n>>> from jira import JIRA\n>>> my_jira_client = JIRA(\"https://my-jira-server.com\", basic_auth=(\"MYUSERNAME\",\"MYPASSWORD\"))\n>>> tb = JiraAgileToolBox(my_jira_client)\n>>> tb.rank_issues_by_list([my_jira_client.issue(\"JAT-001\"), my_jira_client.issue(\"JAT-003\")], my_jira_client.issue(\"JAT-005\"))\n```\n\nwill rank issues like:\n\n| original | result |\n| -------- | ------ |\n| JAT-010 | JAT-010\n| JAT-005 | JAT-001\n| JAT-003 | JAT-003 \n| JAT-002 | JAT-005\n| JAT-001 | JAT-002\n\n- ### more explanation and examples can be found here\n    \n    https://jira-agile-toolbox.readthedocs.io/en/stable/#api-documentation\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Extends standard jira package with agile specific tooling for metrics and administration",
    "version": "0.0.15",
    "project_urls": {
        "Documentation": "https://jira-agile-toolbox.readthedocs.io/",
        "Homepage": "https://github.com/studioj/jira-agile-toolbox",
        "Repository": "https://github.com/studioj/jira-agile-toolbox.git"
    },
    "split_keywords": [
        "agile",
        " api",
        " atlassian",
        " jira",
        " kanban",
        " rest",
        " scrum",
        " web"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "90e3af929680e7b8f611f0a8c159a268e2b1832284de897e0aa284df02d9d893",
                "md5": "51e222fcafec6a2fde38b74d64252358",
                "sha256": "7d9c8d58d071effc35a4829abc7e3a4e3ffa0e84e4c43eaa2840832d183ece56"
            },
            "downloads": -1,
            "filename": "jira_agile_toolbox-0.0.15-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "51e222fcafec6a2fde38b74d64252358",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 6383,
            "upload_time": "2025-09-13T12:22:09",
            "upload_time_iso_8601": "2025-09-13T12:22:09.249488Z",
            "url": "https://files.pythonhosted.org/packages/90/e3/af929680e7b8f611f0a8c159a268e2b1832284de897e0aa284df02d9d893/jira_agile_toolbox-0.0.15-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e9c3a869e09896e02d787c6f48be624c60e651ecaf86785ab732dda81ff05e23",
                "md5": "9b78b8b5a2a881a1f6effbb806b9fe32",
                "sha256": "bb64d1d6246b527adf278da34575909934e421fb8ab94da00e52a1b732efcf9e"
            },
            "downloads": -1,
            "filename": "jira_agile_toolbox-0.0.15.tar.gz",
            "has_sig": false,
            "md5_digest": "9b78b8b5a2a881a1f6effbb806b9fe32",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 10833,
            "upload_time": "2025-09-13T12:22:10",
            "upload_time_iso_8601": "2025-09-13T12:22:10.722702Z",
            "url": "https://files.pythonhosted.org/packages/e9/c3/a869e09896e02d787c6f48be624c60e651ecaf86785ab732dda81ff05e23/jira_agile_toolbox-0.0.15.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-13 12:22:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "studioj",
    "github_project": "jira-agile-toolbox",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "jira",
            "specs": [
                [
                    "==",
                    "3.5.0"
                ]
            ]
        }
    ],
    "lcname": "jira-agile-toolbox"
}
None
Elapsed time: 2.90898s