Skip to main content

CLI tool for automation of user actions on a JIRA instance

Project description

Jira Off-load Tool - JOFT

What is this?

JOFT is a CLI tool for automation of user actions on a JIRA instance. This was created because the build-in automation in JIRA is not sufficient when you want to do complex actions without having the admin rights on the instance.

How does it work?

To do automation with JOFT you first need to write a yaml template file which will actually hold your actions that you want execute. You can execute actions per issue from a JQL trigger query or without it.

If you provide a specific trigger JQL query in the yaml file, all the described actions defined in a yaml template file will execute once per issue found by the trigger JQL query. A yaml template file can have only JQL trigger query. If you need more create another yaml template file with a different query.

If you don't provide the trigger JQL query, the defined actions will execute once.

Installation

Clone the repo. Create a virtualenv with the tool of your liking just make sure the Python version is 3.11 and higher.

To install the tool go to the root dir of the project, activate your venv, and run pip install .. For development, run pip install -e . instead.

To run all tests and type-checker run tox.

Usage

First you need to have a jira instance and an account on that instance. Then you need get personal access token your PAT token. To be able to work with JOFT create a config for your JIRA instance in the root of the project folder. There is an default config example you can use in the project folder joft.config.toml.default. Just remove the .default from the end of the file and add your credentials and you are good to go.

To get help run the tool in CLI withou any options:

joft.

To validate your yaml template file run:

joft validate --template ./<path to your yaml template>

To run the actions from your yaml template file run:

joft run --template ./<path to your yaml template>

If you need more verbose output for debugging, define JOFT_DEBUG=1 environment variable.

Docs

Documentation can be found here.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

joft-0.1.1.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

joft-0.1.1-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file joft-0.1.1.tar.gz.

File metadata

  • Download URL: joft-0.1.1.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.7

File hashes

Hashes for joft-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fd259fa48a2e69a0bf31efe8ee1087b7fb13ae7a0c48d1617bd35cf5d774ee8b
MD5 74e20287a3c217f168dc0ca8db7589c3
BLAKE2b-256 df38363488084c89582a5fce2552c8db42ae638add05a356be2ff311c17c409d

See more details on using hashes here.

Provenance

File details

Details for the file joft-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: joft-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.7

File hashes

Hashes for joft-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3e539586e2d2bc56d0e1fd09c42700937c84c767a839651b9454ce8cb798ee1f
MD5 3a6a5c6bf07bc716f81876854bea97e6
BLAKE2b-256 9785d6947fa8fec06cdff393a66270b356d2e7f92d0ccfd0b315720db961737f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page