This is a tool meant to be run from the command line with the intention of being simple, light and easy to manage hence all contained within a single file.
The script allows to interact with the jira cloud platform in a way that it's easy to create a wrapper around it to place one's logic over it for virtually any purpose be it generating statistics about issues, opening new issues, and many more.
While most python installations should already contain the necessary modules by default they can be installed by running the following command
sudo pip install --upgrade pip
pip install -r requirements.txtpython setup.py --baseUrl <jira url> --userName <jira username> --apiKey <jira api key>| Option | Type | Value |
|---|---|---|
| --baseUrl | String | The url to acces the jira project: example.com:8080 or domain.jira.net |
| --userName | String | The user name used to login |
| --apiKey | String | The generated api key from the jira interface, will be used as password |
cp jira.py $HOME/bin/
chmod +x $HOME/bin/jira.pypython jira.py| Option | Type | Value | Required |
|---|---|---|---|
| -a, --action | String | listBoards | Yes |
| --name | String | All or part of the name of the desired board | No |
| --maxResults | Int | Max number of results, by default 50 | No |
| Option | Type | Value | Required |
|---|---|---|---|
| -a, --action | String | issuesByBoard | Yes |
| --boardId | Int | The id of the board | Yes |
| --startAt | Int | The record from which the query start | No |
| --maxResults | Int | Max number of results, by default 50 | No |
| Option | Type | Value | Required |
|---|---|---|---|
| -a, --action | String | metadataForIssues | Yes |
| Option | Type | Value | Required |
|---|---|---|---|
| -a, --action | String | metadataForIssues | Yes |
| --projectId | Int | The id of the project | No |
| --summary | String | A summary of the issue | No |
| --description | String | A description of the issue | No |
| --issuetype | Int | The id of the issue, can be taken from the issue metadata | No |
| --userName | String | The username to whom the issue will be assigned | No |
| String | The email to whom the issue will be assigned | No |
