Connect Excel with Jira
Project description
Jira Assistant - Connect Excel with Jira
Collecting 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>.
Installation
jira-assistant can be installed from PyPI using pip (note that the package name is different from the importable name):
pip install -U jira-assistant
Download
jira-assistant is available on PyPI https://pypi.org/project/jira-assistant
Code
The code and issue tracker are hosted on GitHub: https://github.com/SharryXu/jira-assistant
Features
Parsing 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.
Documentation
For full documentation, including installation, tutorials and PDF documents, please see https://jira-assistant.readthedocs.io/en/stable/
Get Started
You can run below command in the PowerShell (Windows OS) or Shell (UNIX OS) to process the excel files.
process-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:
process-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.
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-definition --output_folder <folder_you_want>
For more details, please check the help message like below:
generate-template -h
Code Example For Developer
Here’s a simple program, just to give you an idea about how to use this package.
import pathlib
from jira_assistant import run_steps_and_sort_excel_file
HERE = 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 the
PreProcessSteps
list, you can determine the procedure which will be triggered before sorting and also inside theSortStrategyPriority
list, you can decide the sort algorithms’ order. Note: We need to make sure there is one column named StoryId and only one.
[
{
"PreProcessSteps": [
{
"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": "entryDate",
"Type": "datetime",
"RequireSort": false,
"SortOrder": false,
"ScopeRequireSort": false,
"ScopeSortOrder": false,
"InlineWeights": 0,
"RaiseRanking": 0,
"ScopeRaiseRanking": 0
}
]
}
]
Indicating the definition file location to the
run_steps_and_sort_excel_file
method 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 example
run_steps_and_sort_excel_file(
HERE / "source.xlsx",
HERE / "target.xlsx",
sprint_schedule_file=HERE / "milestone_priority.json"
)
License
All contributions after December 1, 2022 released under MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jira_assistant-0.1.22-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6832cc746718d1518fff19e5433d84c1dba26fe16cc939544b112e2d29d72e4f |
|
MD5 | 9a5af9cbdae7753885f7f09cdc6776d6 |
|
BLAKE2b-256 | 30ba714c5b057f3f277890265bd761f8b7948f4e8610b83adbcc7313697f7170 |