getjticket 1.0.1__tar.gz

getjticket-1.0.1/LICENSE

@@ -0,0 +1,11 @@
+Copyright (c) 2024 Juan Jose Solorzano Carrillo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.

getjticket-1.0.1/PKG-INFO

@@ -0,0 +1,80 @@
+Metadata-Version: 2.4
+Name: getjticket
+Version: 1.0.1
+Summary: A tool to fetch and display JIRA ticket information in the terminal.
+Author-email: Juan Jose Solorzano <juanjose.solorzano.c@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.8
+Requires-Dist: colored>=1.4.4
+Requires-Dist: pygments>=2.17.0
+Description-Content-Type: text/markdown
+
+# getjticket
+
+> A Jira ticket information fetcher tool via terminal. 
+
+`getjticket` 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 ticket information** directly from the terminal
+- **Display time tracking information** for JIRA issues
+- **Display issue description** for JIRA issues
+- **Environment variable configuration** for JIRA server, username, and password
+- **Works as** a global CLI command after installation
+
+---
+
+## Installation
+
+```bash
+pip install getjticket
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/JuanJoseSolorzano/getjticket_project.git 
+cd getjticket_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
+
+```bash
+
+positional arguments:
+  issue_id              The ID of the JIRA issue (e.g., 6552 for SETV-6552).
+
+optional arguments:
+  -h, --help    show this help message and exit
+
+  -t TIME,        --time         Shows the time tracking information for the JIRA issue in a pretty format [optional].
+  -d DESCRIPTION, --description  Shows the description of the JIRA issue in a pretty format [optional].
+
+  NOTE: If no optional arguments are provided, the tool will display the issue summary and key by default.
+```
+
+### Examples
+
+```bash
+getjticket 6552 -t "Time tracking information for the JIRA issue."
+getjticket 6552 -d "Description of the JIRA issue."
+```
+---
+
+## License
+
+See [LICENSE](LICENSE) for details.
+
+---
+
+## Author
+
+**Juan Jose Solorzano Carrillo** — juanjose.solorzano.c@gmail.com

getjticket-1.0.1/README.md

@@ -0,0 +1,69 @@
+# getjticket
+
+> A Jira ticket information fetcher tool via terminal. 
+
+`getjticket` 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 ticket information** directly from the terminal
+- **Display time tracking information** for JIRA issues
+- **Display issue description** for JIRA issues
+- **Environment variable configuration** for JIRA server, username, and password
+- **Works as** a global CLI command after installation
+
+---
+
+## Installation
+
+```bash
+pip install getjticket
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/JuanJoseSolorzano/getjticket_project.git 
+cd getjticket_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
+
+```bash
+
+positional arguments:
+  issue_id              The ID of the JIRA issue (e.g., 6552 for SETV-6552).
+
+optional arguments:
+  -h, --help    show this help message and exit
+
+  -t TIME,        --time         Shows the time tracking information for the JIRA issue in a pretty format [optional].
+  -d DESCRIPTION, --description  Shows the description of the JIRA issue in a pretty format [optional].
+
+  NOTE: If no optional arguments are provided, the tool will display the issue summary and key by default.
+```
+
+### Examples
+
+```bash
+getjticket 6552 -t "Time tracking information for the JIRA issue."
+getjticket 6552 -d "Description of the JIRA issue."
+```
+---
+
+## License
+
+See [LICENSE](LICENSE) for details.
+
+---
+
+## Author
+
+**Juan Jose Solorzano Carrillo** — juanjose.solorzano.c@gmail.com

getjticket-1.0.1/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "getjticket"
+version = "1.0.1"
+authors = [
+    { name="Juan Jose Solorzano", email="juanjose.solorzano.c@gmail.com" }
+]
+description = "A tool to fetch and display JIRA ticket information in the terminal."
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+    "pygments>=2.17.0",
+    "colored>=1.4.4"
+]
+
+# Right side: package_folder.module_file:function_name
+[project.scripts]
+getjticket = "getjticket.getjticket:run"  # Creates the global 'getjticket' terminal command!

getjticket-1.0.1/src/getjticket/getjticket.py

@@ -0,0 +1,127 @@
+import requests
+import os
+import argparse
+import re
+import sys
+sys.stdout.reconfigure(encoding="utf-8")#type: ignore
+sys.stderr.reconfigure(encoding="utf-8")#type: ignore
+from colored import Fore,Style
+from requests.auth import HTTPBasicAuth
+from pygments import highlight
+from pygments.lexers import TextLexer, get_lexer_by_name
+from pygments.formatters import TerminalTrueColorFormatter
+from datetime import date
+
+JIRA_SERVER = os.getenv("JIRA_SERVER","")
+USERNAME = os.getenv("JIRA_USERNAME","")
+PASSWORD = os.getenv("JIRA_PASSWORD","")
+TODAY = date.today().strftime("%d/%m/%Y")
+ISSUE_KEY = "SETV-%s"
+URL = "https://{0}/rest/api/2/issue/{1}/comment"
+HEADERS = {"Accept": "application/json","Content-Type": "application/json"}
+PAYLOAD = {"body": ""}
+SEPARATOR = '─' * 100
+SEPARATOR_2 = '═' * 100
+PINK =   Fore.rgb("100%", "0%", "60%")
+GRAY = Fore.rgb("50%", "50%", "50%")
+PARAMS = {"fields": "summary,description,timespent,timeestimate,timetracking,worklog"}
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(description="Add a comment to a JIRA issue.")
+    parser.add_argument("issue_id", type=int, help="The ID of the JIRA issue (e.g., 6552 for SETV-6552).")
+    parser.add_argument("-d", "--description", action="store_true", default=False, help="Show detailed information about the issue.")
+    parser.add_argument("-t", "--time", action="store_true", default=False, help="Show time tracking information for the issue.")
+    return parser.parse_args()
+
+def markup2markdown(text):
+    # Remove separators
+    text = re.sub(r'^[-=]{4,}\s*$', '', text, flags=re.MULTILINE)
+    # Headings: h1. text -> # text
+    for i in range(1, 7):
+        text = re.sub(rf'^h{i}\.\s*(.*)$', lambda m: f"{'#' * i} {m.group(1)}", text, flags=re.MULTILINE)
+    # Bullet points
+    text = re.sub(r'^\s*\*\s+', '- ', text, flags=re.MULTILINE)
+    # Blockquotes
+    text = re.sub(r'^\s*>\s?', '> ', text, flags=re.MULTILINE)
+    # Bold: *text* -> **text**
+    text = re.sub(r'\*(.*?)\*', r'**\1**', text)
+    # Italic: _text_ -> _text_
+    text = re.sub(r'_(.*?)_', r'_\1_', text)
+    # Inline code: {{code}} -> `code`
+    text = re.sub(r'\{\{(.*?)\}\}', r'`\1`', text)
+    # Clean extra blank lines
+    text = re.sub(r'\n{3,}', '\n\n', text)
+    return text.strip()
+
+def connect_jira(issue_id:str) -> requests.Response:
+    url = f"https://{JIRA_SERVER}/rest/api/2/issue/{ISSUE_KEY % issue_id}"
+    return requests.get(
+        url,
+        params=PARAMS,
+        auth=HTTPBasicAuth(USERNAME, PASSWORD),
+        headers={"Accept": "application/json"}
+    )
+
+def get_time_tracking_info(fields, linK_to_issue, issue_id) -> None:
+    worklogs = fields["worklog"]["worklogs"]
+    estimated = fields["timetracking"]["originalEstimate"]
+    remaining = fields["timetracking"]["remainingEstimate"]
+    try:
+        time_spent = fields["timetracking"]["timeSpent"]
+    except KeyError:
+        time_spent = "0s"
+    print(SEPARATOR)
+    print(f"Issue ID: {ISSUE_KEY % issue_id}")
+    print(f"Summary: {fields['summary']}")
+    print(f"Link to Issue: {linK_to_issue}")
+    print(" ")
+    print(f"{'':<25}[- TIME TRACKING INFORMATION -]")
+    print(" ")
+    print(f"{'Original Estimate:':<20} {estimated}")
+    print(f"{'Remaining Time:':<20} {remaining}")
+    print(f"{'Time Spent:':<20} {time_spent}")
+
+    print(SEPARATOR_2)
+    print(f"{'Author':<25} {'Started':<20} {'Time Spent':<12} Comment")
+    print(SEPARATOR)
+
+    for worklogged in worklogs:
+        author = worklogged["author"]["displayName"]
+        time_spent = worklogged["timeSpent"]
+        started = worklogged["started"].replace("T", " ").replace(".000+0000", "")
+        comment = worklogged.get("comment", "")
+        comment = comment[:50] + "..." if len(comment) > 50 else comment
+        print(f"{author:<25} {started:<20} {time_spent:<12} {comment}")
+    print(SEPARATOR_2)
+
+def get_description(fields, linK_to_issue, issue_id) -> None:
+    description = fields.get("description", "No description provided.")
+    cleaned = markup2markdown(description)
+    lexer = get_lexer_by_name("markdown", stripall=True)
+    colored_output = highlight(cleaned, lexer, TerminalTrueColorFormatter()).splitlines()
+    print(SEPARATOR_2)
+    print(f"  {GRAY}{ISSUE_KEY % issue_id} - {fields['summary']}")
+    print(f"  [{linK_to_issue}]{Style.reset}")
+    print(f"{SEPARATOR}")
+    for line_number, line in enumerate(colored_output, start=1):
+        print(f"{GRAY}{line_number:<2}│ {Style.reset}{line}")
+    print(SEPARATOR_2)
+
+def run()->None:
+    args = parse_args()
+    issue_id = args.issue_id
+    linK_to_issue = f"https://{JIRA_SERVER}/browse/{ISSUE_KEY % issue_id}"
+    response = connect_jira(issue_id).json()
+    fields = response["fields"]
+    if args.description:
+        get_description(fields, linK_to_issue, issue_id)
+    elif args.time:
+        get_time_tracking_info(fields, linK_to_issue, issue_id)
+    else:
+        get_description(fields, linK_to_issue, issue_id)
+        get_time_tracking_info(fields, linK_to_issue, issue_id)
+
+if __name__ == "__main__":
+    run()    
+