Python app that uses the JIRA API for automated tasks and aggregate or complex reports that are not possible with filters or gadgets in JIRA web UI.
Features:
-
export_import_issues_for_jql
: export issues from one JIRA instance to another with comments and attachments (see Export/import below) -
list_epics_stories_and_tasks_for_jql
: print a Markdown-compatible tree of epics, stories and subtasks that match the given JQL query -
projects
: List available JIRA projects (mainly for testing) -
fields
: List available JIRA field names and IDs -
sum_timetracking_for_jql
: Sum original estimate, time spent and time remaining for all issues that match the given JQL query -
import_worklogs_from_google_calendar
: Import worklog entries from Google Calendar to corresponding JIRA tasks
git clone https://github.com/mrts/ask-jira.git
cd ask-jira
virtualenv venv
. venv/scripts/activate # or venv/bin/activate in non-Windows
pip install --requirement=requirements.txt
cp jiraconfig-sample.py jiraconfig.py
# edit jiraconfig.py
./ask-jira.py projects # for testing, will print available projects
JIRA server configuration is picked up from jiraconfig.py
.
Run the command with
$ ./ask-jira.py <command> <command-specific parameters>
Here's the default help:
$ ./ask-jira.py
usage: ask-jira.py [-h] command
positional arguments:
command the command to run, available commands:
'export_import_issues_for_jql': Export issues from one JIRA instance
to another with comments and attachments
'fields': List available JIRA field names and IDs
'import_worklogs_from_google_calendar': Import worklog entries from Google Calendar
to corresponding JIRA tasks
'list_epics_stories_and_tasks_for_jql': Print a Markdown-compatible tree of epics,
stories and subtasks that match the given JQL query
'projects': List available JIRA projects
'sum_timetracking_for_jql': Sum original estimate, time spent
and time remaining for all issues that match the given JQL query
optional arguments:
-h, --help show this help message and exit
# current sprint velocity
./ask-jira.py sum_timetracking_for_jql 'project = PROJ and sprint in openSprints() and status = Closed'
./ask-jira.py list_epics_stories_and_tasks_for_jql 'project = PROJ and type = Epic'
The export_import_issues_for_jql
task exports issues from one JIRA instance
to another with comments, attachments, epics and sub-tasks.
Source JIRA server configuration is picked up from jiraconfig.py
.
The task needs special configuration in exportimportconfig.py
(see sample in
exportimportconfig-sample.py
):
JIRA
: the target JIRA server configuration where the issues are exported toPRIORITY_MAP
: map source JIRA priorities to target priorities, e.g.'Major': 'Medium'
ISSUETYPE_MAP
: map source JIRA issue types to target issue types, e.g.'New Feature': 'Story'
ASSIGNEE_MAP
: map source JIRA assignees to target assigneesREPORTER_MAP
: map source JIRA reporters to target reporters (usually identical toASSIGNEE_MAP
)SOURCE_EPIC_LINK_FIELD_ID
: ID of the epic field in source JIRA, find it by callingfields
, look for Epic LinkSOURCE_EPIC_NAME_FIELD_ID
: ID of the epic field in source JIRA, find it by callingfields
, look for Epic NameTARGET_EPIC_NAME_FIELD_ID
: ID of the epic field in target JIRA, find it by changing configuration to use target JIRA and callingfields
, look for Epic NameSTATUS_TRANSITIONS
: map of source JIRA statuses to list of workflow transition names in target JIRA that result in equivalent status,None
for no transitionSTATUS_TRANSITIONS_ISSUETYPE
: issuetype specific map of source JIRA statuses to list of workflow transition names in target JIRA that result in equivalent status,None
for no transition. If an issuetype is not in this list, the defaultSTATUS_TRANSITIONS
are used.RESOLUTION_MAP
: map source JIRA resolutions to target resolutions, only used when aWithResolution
transition is used inSTATUS_TRANSITIONS
ADD_COMMENT_TO_OLD_ISSUE
: ifTrue
, add comment to source JIRA issue that it was exported to new issue in target JIRA with issue linkCUSTOM_FIELD
: a single custom field that you can set to a default value for all issues (set toNone
if not needed)CUSTOM_FIELD_MAP
: map source JIRA fields to target JIRA fields. This can also be used for system fields that are not mapped out of the box, such as 'environment'CUSTOM_FIELD_STATIC
: map target JIRA fields to static values that should be added regardless of what that field contains in the source JIRACUSTOM_FIELD_STATIC_ISSUETYPE
: issuetype specific map of target JIRA fields to static values. If an issuetype is not in this list, the defaultCUSTOM_FIELD_STATUC
is used.
Note that epics and sub-tasks should be excluded from the source JIRA query as they are automatically imported via the parent task. The the recommended snippet to add to the query is:
AND issuetype not in subTaskIssueTypes() AND issuetype != Epic
Full example:
./ask-jira.py export_import_issues_for_jql 'project = PROJ
AND status not in (Closed, Done, Fixed, Resolved)
AND issuetype not in subTaskIssueTypes()
AND issuetype != Epic'
The import_worklogs_from_google_calendar
task helps filling JIRA time reports
from Google Calendar events. The Google Calendar events must be formatted
according to JIRA-ID: comment convention, where JIRA-ID is the JIRA issue
ID and comment is the comment to add to the worklog. The comment is optional.
The script finds the corresponding JIRA issue by ID and adds a worklog with the
event duration to it.
It needs special configuration in worklogconfig.py
(see sample in
worklogconfig-sample.py
, you probably need to change the Google Calendar
timezone in TIMEZONE
and can keep the rest as-is).
You also need to setup API access to Google Calendar in Google Developers
Console as explained here.
Be sure to download the OAuth client secret as instructed and save it to
~/.credentials/client_secret.json
.
Usage:
./ask-jira.py import_worklogs_from_google_calendar -h
usage: ask-jira.py [-h] command calendar fromdate todate
positional arguments:
command import_worklogs_from_google_calendar
calendar the calendar name to import worklogs from
fromdate import date range start, in yyyy-mm-dd format
todate import date range end, in yyyy-mm-dd format
Full example:
./ask-jira.py import_worklogs_from_google_calendar 'Timereport' 2017-02-23 2017-02-24