Skip to main content

CLI for Red Hat Jira (https://redhat.atlassian.net)

Project description

rhjira-python is a utility and library that provides functionality to interact with Red Hat's Jira (https://redhat.atlassian.net). The functionality in this project currently supports creating, editing, commenting on, and the displaying of jiras.

Configuration

Token Configuration

rhjira-python requires a Jira Token (from your Atlassian account security settings). The token can be exported as JIRA_TOKEN, however it is recommended users execute 'rhjira settoken' to store their token in their keyring. This is more secure than keeping the token in clear text and using JIRA_TOKEN.

When running 'rhjira settoken', you will be prompted for the Jira server URL (default https://redhat.atlassian.net), then an optional email address. The email is required for Atlassian Cloud instances (see below). Both server and email are stored in the keyring alongside your token.

Tokens can be removed from the keyring by simply removing the 'rhjira' entry. In the commonly used seahorse application, this can be done by removing the 'Password for '{username}' on 'rhjira'' entry. Similarly, the stored email can be removed by deleting the 'rhjira-email' entry, and the stored server by deleting the 'rhjira-server' entry.

Server Configuration

By default, rhjira connects to https://redhat.atlassian.net. To connect to a different Jira instance, set the JIRA_SERVER environment variable or run 'rhjira settoken' and enter the server URL when prompted (it is saved in the keyring):

export JIRA_SERVER="https://your-jira-instance.atlassian.net"

Atlassian Cloud instances require an email address for authentication. You can provide this in two ways:

  1. When running 'rhjira settoken' (recommended - stores in keyring)
  2. Via the JIRA_EMAIL environment variable:
export JIRA_EMAIL="your.email@example.com"

Environment Variable Priority

Environment variables take priority over keyring values, allowing for easy testing and per-session overrides:

  • JIRA_TOKEN overrides the keyring token
  • JIRA_EMAIL overrides the keyring email
  • JIRA_SERVER overrides the keyring server and default server URL

Help

All commands are supported via --help. For example, to get help on the comment command, execute "rhjira comment --help".

Problems found with rhjira-python can be reported at https://gitlab.com/prarit/rhjira-python/-/issues. As with all my projects, merge requests are welcomed!

Bugs with rhjira should include the version of rhjira you are running and the exact executed command that failed.

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

rhjira-4.0.5.tar.gz (65.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rhjira-4.0.5-py3-none-any.whl (40.2 kB view details)

Uploaded Python 3

File details

Details for the file rhjira-4.0.5.tar.gz.

File metadata

  • Download URL: rhjira-4.0.5.tar.gz
  • Upload date:
  • Size: 65.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for rhjira-4.0.5.tar.gz
Algorithm Hash digest
SHA256 6ae740d27386486297f725e33772db951b5b2a4df18d44e9d97aad29e0b319c9
MD5 ded377f8fdefd60802186764e1c99266
BLAKE2b-256 1bd8aa5b0d8bedf27e068023c842c9f31a88139bda9d3106a7b8c5c1308ca2dd

See more details on using hashes here.

File details

Details for the file rhjira-4.0.5-py3-none-any.whl.

File metadata

  • Download URL: rhjira-4.0.5-py3-none-any.whl
  • Upload date:
  • Size: 40.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for rhjira-4.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 952a19d02138b5044544fa27a668af3d407cf78e6658d6427414eedc386f4a4f
MD5 a62f7a3fbb13252d1605dad9e262bc26
BLAKE2b-256 7d2aa12826d27be00b0c7bbf707d4026353dbb7e581c1a6e0759ef8fff116356

See more details on using hashes here.

Supported by

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