# jira_agile_toolbox
[](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>
[](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": "https://github.com/studioj/jira-agile-toolbox",
"name": "jira-agile-toolbox",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "api,atlassian,jira,rest,web,agile,scrum,kanban",
"author": "Jef Neefs",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/7c/88/475a1d51e138f63033818a5afcf2c000a06cc0fbb7f59deacc3d95fe886e/jira_agile_toolbox-0.0.13.tar.gz",
"platform": "unix",
"description": "# jira_agile_toolbox\n\n\n\n[](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[](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.13",
"project_urls": {
"Homepage": "https://github.com/studioj/jira-agile-toolbox"
},
"split_keywords": [
"api",
"atlassian",
"jira",
"rest",
"web",
"agile",
"scrum",
"kanban"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b74dc1101201081bcbe939e5f8d117c959a6ebd947cc1ed23ceb103c4482d30",
"md5": "7676567977c430763de0b64466f48cdc",
"sha256": "65b83ca6ff9fd6a37cf20e55ccc36c345f6f2fe170ddc0f7572a7031b0ac2334"
},
"downloads": -1,
"filename": "jira_agile_toolbox-0.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7676567977c430763de0b64466f48cdc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6309,
"upload_time": "2023-05-16T20:20:18",
"upload_time_iso_8601": "2023-05-16T20:20:18.710017Z",
"url": "https://files.pythonhosted.org/packages/7b/74/dc1101201081bcbe939e5f8d117c959a6ebd947cc1ed23ceb103c4482d30/jira_agile_toolbox-0.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c88475a1d51e138f63033818a5afcf2c000a06cc0fbb7f59deacc3d95fe886e",
"md5": "8c942a532f9d602795bfc6915d0948e7",
"sha256": "adaa2fe1cd0e4f2b74d4a3d333fcd1ce44e82737039242ec40621a979571b17f"
},
"downloads": -1,
"filename": "jira_agile_toolbox-0.0.13.tar.gz",
"has_sig": false,
"md5_digest": "8c942a532f9d602795bfc6915d0948e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 18354,
"upload_time": "2023-05-16T20:20:20",
"upload_time_iso_8601": "2023-05-16T20:20:20.020839Z",
"url": "https://files.pythonhosted.org/packages/7c/88/475a1d51e138f63033818a5afcf2c000a06cc0fbb7f59deacc3d95fe886e/jira_agile_toolbox-0.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-16 20:20:20",
"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"
}
JSON
