sharry-jira-tool

######################## ⚠️⚠️⚠️ Summary ⚠️⚠️⚠️ ########################

########################################################################################################################## ⚠️⚠️⚠️ This package was been deprecated. Please use jira-assistant <https://pypi.org/project/jira-assistant/>_ ⚠️⚠️⚠️ ##########################################################################################################################

############################################################### Documentation: https://jira-assistant.readthedocs.io/en/stable/ ###############################################################

Jira Tool - userful tool to sort jira stories

|pypi| |python 3.11| |python 3.11 (Mac OS)| |CodeQL| |Documentation|

.. |PyPI| image:: https://img.shields.io/pypi/v/sharry-jira-tool.svg?style=flat-square :target https://pypi.org/project/sharry-jira-tool/ :alt: pypi version

.. |python 3.11| image:: https://github.com/jira-assistant/jira-tool/actions/workflows/python-3-11-test.yml/badge.svg :target: https://github.com/jira-assistant/jira-tool/actions/workflows/python-3-11-test.yml :alt: python 3.11

.. |python 3.11 (Mac OS)| image:: https://github.com/jira-assistant/jira-tool/actions/workflows/python-3-11-macos-test.yml/badge.svg :target: https://github.com/jira-assistant/jira-tool/actions/workflows/python-3-11-macos-test.yml :alt: python 3.11 (Mac OS)

.. |CodeQL| image:: https://github.com/jira-assistant/jira-tool/workflows/CodeQL/badge.svg :target: https://github.com/jira-assistant/jira-tool/actions/workflows/CodeQL.yml :alt: CodeQL

.. |Documentation| image:: https://readthedocs.org/projects/jira-tool/badge/?version=latest :target: https://jira-tool.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

Installation

jira-tool can be installed from PyPI using pip (note that the package name is different from the importable name)::

pip install -U sharry-jira-tool

Download

jira-tool is available on PyPI https://pypi.org/project/sharry-jira-tool

Code

The code and issue tracker are hosted on GitHub: https://github.com/jira-assistant/jira-tool

Features

• Parsing the excel file which usually been downloaded from the Jira platform.
• Sorting the excel records using some specific logic.
• Generating the target excel file which contains the result.
• The excel file structure can be customized by JSON file.

A Simple Example

You can run below command in the PowerShell (Windows OS) or Shell (UNIX OS) to process the excel files.

.. code-block:: console

sort-excel-file source.xlsx

After that, you can find the output file in the same folder along with the source file. For more details, please check the help message like below:

.. code-block:: console

sort-excel-file -h

Currently, we are using the jira access token__ to do the validation and that means we need you to generate your own access token from the website first.

.. __: https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html

.. code-block:: console

update-jira-info --token <access_token> --url <jira_url>

If you want to use your own definition files before processing the excel, you can run below command to access some templates which can help you understand the definition file.

.. code-block:: console

generate-template excel-definition

For more details, please check the help message like below:

.. code-block:: console

generate-template -h

Code Example For Developer

Here's a simple program, just to give you an idea about how to use this package.

.. code-block:: python

import pathlib from jira_tool import process_excel_file HERE = pathlib.Path().resolve() process_excel_file(HERE / "source.xlsx", HERE / "target.xlsx")

If you want to customize the definition file to adapt the new Excel, you can do below steps.

1. Creating the definition file like below. Inside the :code:PreProcessSteps list, you can determine the procedure which will be triggered before sorting and also inside the :code:SortStrategyPriority list, you can decide the sort algorithms' order.

.. code-block:: json

[ { "PreProcessSteps": [ { "Name": "FilterOutStoryWithoutId", "Enabled": true, "Config": {} }, { "Name": "RetrieveJiraInformation", "Enabled": true, "Config": {} }, { "Name": "FilterOutStoryBasedOnJiraStatus", "Enabled": true, "Config": { "JiraStatuses": [ "SPRINT COMPLETE", "PENDING RELEASE", "PRODUCTION TESTING", "CLOSED" ] } } ], "SortStrategies": [ { "Name": "InlineWeights", "Priority": 1, "Enabled": true, "Config": {} }, { "Name": "SortOrder", "Priority": 2, "Enabled": true, "Config": {} }, { "Name": "SortOrder", "Priority": 3, "Enabled": true, "Config": { "ParentScopeIndexRange": "12-19" } }, { "Name": "RaiseRanking", "Priority": 4, "Enabled": true, "Config": { "ParentScopeIndexRange": "12-19" } } ] }, { "Columns": [ { "Index": 1, "Name": "entryDate", "Type": "datetime", "RequireSort": false, "SortOrder": false, "ScopeRequireSort": false, "ScopeSortOrder": false, "InlineWeights": 0, "RaiseRanking": 0, "ScopeRaiseRanking": 0 } ] } ]

1. Indicating the definition file location to the :code:process_excel_file method like below.

.. code-block:: python

process_excel_file( HERE / "source.xlsx", HERE / "target.xlsx", excel_definition_file=HERE / "definition_file.json" )

Meantime, you can follow the same way to customize the milestone priority file.

1. Configuration file

.. code-block:: json

[ { "Priority": 1, "Sprints": ["R134 S1", "M109"] } ]

1. Code example

.. code-block:: python

process_excel_file( HERE / "source.xlsx", HERE / "target.xlsx", sprint_schedule_file=HERE / "milestone_priority.json" )

Author

The jira-tool module was written by Sharry Xu [e-mail] in 2022.

Starting with version 0.1.13, the main function of this project has been totally finished.

Contact

Our mailing list is available at [e-mail].

License

All contributions after December 1, 2022 released under MIT license.