Skip to main content

A tool to log time to JIRA issues directly from the terminal.

Project description

getjinfo

A Jira ticket information fetcher tool via terminal.

getjinfo allows you to fetch and display JIRA ticket information directly from your terminal. This tool uses the REST API of JIRA to interact with your JIRA server, and requires environment variables for configuration.

Features

  • Fetch JIRA Sprint information directly from the terminal
  • Display info about the active Sprint for the project
  • Environment variable configuration for JIRA server, username, and password
  • Works as a global CLI command after installation

Installation

pip install getjinfo

Or install from source:

git clone https://github.com/JuanJoseSolorzano/getjinfo_project.git 
cd getjinfo_project
pip install .

Required Environment Variables

  • JIRA_SERVER: The URL of your JIRA server (e.g., yourdomain.atlassian.net).
  • JIRA_USERNAME: Your JIRA username (usually your email address).
  • JIRA_PASSWORD: Your JIRA API token or password.

Usage

usage: getjinfo.py [-h] [-q QUERY] [-u USER] [--all-user ALL_USER] [-m MAX] [-s] [--all-me] [--all] [--curr-sprint]

Add a comment to a JIRA issue.

optional arguments:
  -h, --help            show this help message and exit

  -q, --query      QUERY      Custom JQL query to fetch issues.
  -u, --user       USER       Show detailed information about the issue.
  -m, --max        MAX        The maximum number of results.
  -s, --sprint     Show       issues in the current sprint.
  --all-user       ALL_USER   Show all issues assigned to the specified user.
  --all-me         ------     Show all  issues assigned to the current user.
  --all            ------     Show all  issues in the project.
  --curr-sprint    ------     Show issues in the current sprint.

Examples

getjinfo -u juso006 -s # Show detailed information about the issue with key "juso006" in the current sprint.
getjinfo --all-me # Show all issues assigned to the current user.
getjinfo --all # Show all issues in the project.
getjinfo -s # Show issues in the current sprint.
getjinfo -q '[QUERY AS IN THE JIRA SEARCH BAR]' # Show issues based on a custom JQL query.
getjinfo --all-user juso006 # Show all issues assigned to the user "juso006".
getjinfo --all -m 50 # Show all issues in the project, but limit the results to 50.

License

See LICENSE for details.


Author

Juan Jose Solorzano Carrillojuanjose.solorzano.c@gmail.com

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

getjinfo-1.1.1.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

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

getjinfo-1.1.1-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file getjinfo-1.1.1.tar.gz.

File metadata

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

File hashes

Hashes for getjinfo-1.1.1.tar.gz
Algorithm Hash digest
SHA256 590da597f16c02e91e6cfc7f6b176dfeaafc06d4864c93f340f0b04452bb0412
MD5 4ac51a92fc3270ce49ceb7ca1b3a4cb4
BLAKE2b-256 d274ab7aaee93c7caa16009b22156001a9cef57b9276a8ced91579d25897508f

See more details on using hashes here.

File details

Details for the file getjinfo-1.1.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for getjinfo-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 852092e67884e005844bf2a0e120c2b186e6ac8a1bdbbb829f706dc6ded098ca
MD5 5d7233480f1d423619c18a85fa3259e7
BLAKE2b-256 b43fa71d69321eaa28deaeb5b07f1c90ffae6a0be37fc702c63628334f3d0210

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