Package: jira-assistant
Jira Assistant - Connect Excel with JiraCollecting Ideas!!!If you have any ideas or good requirements related to this package, please let us know and we will do our best to fulfill! Please send emails to <sharry.xu@outlook.com>.Installationjira-assistantcan be installed from PyPI usingpippip install -U jira-assistantDownloadjira-assistant is available on PyPIhttps://pypi.org/project/jira-assistantCodeThe code and issue tracker are hosted on GitHub:https://github.com/jira-assistant/jira-assistantFeaturesParsing the excel file using information from the Jira platform.Create new stories on the Jira platform.Multiple existed procedures (retrieving additional info, customized filter and etc.) can be choosed and combined to apply for the processing.Sorting the records based on multiple sorting algorithms which can be modified and combined in the JSON file.The excel file structure can be customized by JSON file.DocumentationFor full documentation, including installation, tutorials and PDF documents, please seehttps://jira-assistant.readthedocs.io/en/stable/Get StartedYou can run below command in the PowerShell (Windows OS) or Shell (UNIX OS) to process the excel files.process-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:process-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 --access-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-definition --output-folder <folder_you_want>For 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_assistantimportrun_steps_and_sort_excel_fileHERE=pathlib.Path().resolve()run_steps_and_sort_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. Note: We need to make sure there is one column namedStoryIdand only one.[{"version":1},{"PreProcessSteps":[{"Priority":1,"Name":"CreateJiraStory","Enabled":true,"Config":{}},{"Name":"FilterOutStoryWithoutId","Enabled":true,"Priority":1,"Config":{}},{"Name":"RetrieveJiraInformation","Enabled":true,"Priority":2,"Config":{}},{"Name":"FilterOutStoryBasedOnJiraStatus","Enabled":true,"Priority":3,"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":"Entry/Last Updated Date","Type":"datetime","RequireSort":false,"SortOrder":false,"ScopeRequireSort":false,"ScopeSortOrder":false,"InlineWeights":0,"RaiseRanking":0,"ScopeRaiseRanking":0,"JiraFieldMapping":{"name":"customfield_15601","path":"customfield_15601.value"},"QueryJiraInfo":true}]}]Indicating the definition file location to therun_steps_and_sort_excel_filemethod like below.run_steps_and_sort_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 examplerun_steps_and_sort_excel_file(HERE/"source.xlsx",HERE/"target.xlsx",sprint_schedule_file=HERE/"milestone_priority.json")AuthorThe jira-assistant was written by Sharry Xu <sharry.xu@outlook.com> in 2022.Starting with version 0.1.5, the main function of this project has been totally finished.LicenseAll contributions after December 1, 2022 released under MIT license.