jira-python-utils

Collection of Python utils for interacting with JIRA


Keywords
jira_python_utils
License
GPL-3.0
Install
pip install jira-python-utils==0.8.0

Documentation

jira-python-utils

Collection of Python utility scripts interacting with Jira issue tracking system instance.

Motivation

The collection of Python scripts allows uses to quickly and easily interact with Jira via command-line terminal.

Improvements

Please see the TODO for a list of upcoming improvements.

Installation

Please see the INSTALL guide for instructions.

Generate shell wrapper scripts

After executing pip install jira-python-utils, execute this exported script: make_executables_and_aliases.py.
This will create the wrapper shell scripts and a file containing aliases named jira-python-utils-aliases.txt in the current directory.

You can then add this line to your .bashrc or .zshrc:
source dir/jira-python-utils-aliases.txt
where dir is the directory that contains the aliases file.

Exported scripts

The following exported scripts are available:

  • annotate-readme
  • bitbucket-reformat-merge-comment
  • jira-add-change-control-comment
  • jira-add-comment
  • jira-add-component
  • jira-add-label
  • jira-assign-issue
  • jira-convert-task-session-script-to-readme
  • jira-create-issue
  • jira-create-release-software-issues
  • jira-epics-to-confluence-tables
  • jira-get-issue-details
  • jira-initiate-workspace
  • jira-link-issues
  • jira-remove-watcher
  • jira-search-issues
  • jira-start-task
  • jira-sync-workspace
  • jira-to-confluence-weekly-progress-report
  • search-readme

Note that these will only be available after the Python virtual environment is activated.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

To-Do/Coming Next

Please view the listing of planned improvements here.

CHANGELOG

Please view the CHANGELOG here.

License

GNU AFFERO GENERAL PUBLIC LICENSE