https://github.com/marcusoftnet/jira-stat-extractor
https://github.com/marcusoftnet/jira-stat-extractor
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/marcusoftnet/jira-stat-extractor
- Owner: marcusoftnet
- License: unlicense
- Created: 2024-08-09T11:45:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-23T07:31:45.000Z (9 months ago)
- Last Synced: 2025-09-23T09:23:48.944Z (9 months ago)
- Language: Python
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jira Stats Exporter
We use this script to export data about issues from JIRA to be used in our status reporting. The script creates a CSV file that can be imported into the Google Sheet where the statistical processing happens.
The script gets the issues from the passed in JQL and then parses the changelog for each issue to get the Work Started Status (`-s` / `--workstartedstatus`) parameter to get a proper state date
The main reasons for having this script in the first place is that we cannot use "Created" as our start date, since that date often is weeks (and sometime months or years) before actual work starts in the first place. Hence we need to look into the changelog and get the change that indicates the real start of work.
## Using the script
### Prerequisite
The script uses Python 3 and you will have to install that on your computer.
### Quick start
Open a terminal in the same directory as where the `main.py` file is located
Using abbreviations:
```bash
python3 main.py -u {your username} -t {your token} -j {a JQL statement}
```
Using long parameter names:
```bash
python3 main.py --username {your username} --token {your token} --jql {a JQL statement}
```
### Parameters
The script takes 3 required parameters
| Parameter name | Description | Example |
| :--- | :--- | :--- |
| `-u` / `--username` | The username you have generated a token for.
Typically this is your email address | `-u marcus.hammarberg@umain.com` |
| `-t` / `--token` | A token to access the API with. You can [easily generate one here](https://id.atlassian.com/manage-profile/security/api-tokens) | `-t WI34GH9W29843R892F92RH2` |
| `-j` / `--jql` | A JQl query to get issues for. Note that your user needs to have access to things you are querying for; projects, filters etc.
Supply the JQL statement in **double**quotes. You might need to change the quotes in your query to use single quotes. | `"filter = 'Filter for Team 418' and issuetype=Story and statuscategory=Done"` |
There are also two optional parameters that you only need to supply if the default values are not useful
| Parameter name | Description | Default value | Example |
| :--- | :--- | :--- | :--- |
| `-s` / `--workstartedstatus` | The name of the status that should start the clock for our work time. Looking up the first time the issue changed into this status, is the main reason for us having to create this script in the first place.
The comparison is done case-insensitive. | `Implementing` | `-w Accepted` |
| `-o` / `--output` | Name and location of the output file. The file will be created if it doesn't exist and overwritten if it does exist. | `jira-stats-export-{date}` | `-o marcus.csv`
`-o ~/Downloads/export.csv` |
### Full example
```bash
python3 main.py --username marcus.hammarberg@umain.com --token WI34GH9W29843R892F92RH2 --jql "filter = 'Filter for Team 418' and issuetype=Story and statuscategory=Done" --workstartedstatus Accepted --output ~/Downloads/export_291212.csv
```