Jira Report

Generate a monthly .xls report of Jira tasks assigned to me.

Prerequisites

Install poetry:

$ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python

Installation

Install the module after download:

$ poetry install

Configuration

Create a Jira API Token:

1. Go to your Jira account settings.
2. Open Security.
3. Click Create and manage API tokens.
4. Create a new API token.
5. Copy the token to clipboard.

Create a local .env file with the following environment variables:

$ echo 'JIRA_SERVER_URL="https://mycompany.atlassian.net"' >> .env
$ echo 'JIRA_USERNAME="[email protected]"' >> .env
$ echo 'JIRA_API_TOKEN="qeYEtFiNUJ8FCSEbBp25jNKc"' >> .env

Alternatively, the script will show an interactive prompt to generate this file for you.

Usage

The command:

$ poetry run jira-report [--month YYYY/MM] [--days N] [--force-overwrite] [--blacklist <path>]

Example #1

Generate a report for the current month:

$ poetry run jira-report

Example #2

Generate a report for a different month:

$ poetry run jira-report --month 2019/10

Example #3

Generate a report for a different month and a custom number of business days:

$ poetry run jira-report --month 2019/10 --days 9