Package: sharry-jira-tool
⚠️⚠️⚠️ Summary ⚠️⚠️⚠️⚠️⚠️⚠️ This package was been deprecated. Please usejira-assistant⚠️⚠️⚠️Jira Tool - userful tool to sort jira storiesInstallationjira-toolcan be installed from PyPI usingpip(note that the package name is different from the importable name):pip install -U sharry-jira-toolDownloadjira-tool is available on PyPIhttps://pypi.org/project/sharry-jira-toolCodeThe code and issue tracker are hosted on GitHub:https://github.com/jira-assistant/jira-toolFeaturesParsing 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 ExampleYou can run below command in the PowerShell (Windows OS) or Shell (UNIX OS) to process the excel files.sort-excel-file source.xlsxAfter 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:sort-excel-file -hCurrently, we are using thejira access tokento do the validation and that means we need you to generate your own access token from the website first.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.generate-template excel-definitionFor more details, please check the help message like below:generate-template -hCode Example For DeveloperHere’s a simple program, just to give you an idea about how to use this package.importpathlibfromjira_toolimportprocess_excel_fileHERE=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.Creating the definition file like below. Inside thePreProcessStepslist, you can determine the procedure which will be triggered before sorting and also inside theSortStrategyPrioritylist, you can decide the sort algorithms’ order.[{"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}]}]Indicating the definition file location to theprocess_excel_filemethod like below.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.Configuration file[{"Priority":1,"Sprints":["R134 S1","M109"]}]Code exampleprocess_excel_file(HERE/"source.xlsx",HERE/"target.xlsx",sprint_schedule_file=HERE/"milestone_priority.json")AuthorThe jira-tool module was written by Sharry Xu <sharry.xu@outlook.com> in 2022.Starting with version 0.1.13, the main function of this project has been totally finished.ContactOur mailing list is available atsharry.xu@outlook.com.LicenseAll contributions after December 1, 2022 released under MIT license.