setjcomment 1.1.1__tar.gz

setjcomment-1.1.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.

setjcomment-1.1.1/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: setjcomment
+Version: 1.1.1
+Summary: A Jira comment management tool via terminal. Manage your JIRA issue comments directly from the terminal, using the REST API of JIRA. This tool allows you to add comments to JIRA issues using a template file for consistent formatting, and supports multiple editors for editing the comment content.
+Author-email: Juan Jose Solorzano <juanjose.solorzano.c@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# setjcomment
+
+> A Jira comment management tool via terminal. Manage your JIRA issue comments directly from the terminal, using the REST API of JIRA. This tool allows you to add comments to JIRA issues using a template file for consistent formatting, and supports multiple editors for editing the comment content.
+
+`setjcomment` allows you to add comments to JIRA issues directly from your terminal, using a template file for consistent formatting.
+
+---
+
+## Features
+
+- **Add comments to JIRA issues** directly from the terminal
+- **Use a template file** for consistent comment formatting
+- **Supports multiple editors** (nvim, VScode, Notepad)
+- **Environment variable configuration** for JIRA server, username, and password
+- Works as a global CLI command after installation
+
+---
+
+## Installation
+
+```bash
+pip install setjcomment
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/your-username/setjcomment.git
+cd setjcomment
+pip install .
+```
+
+---
+
+## Dependencies
+- [`Pygments`](https://pypi.org/project/Pygments/) for syntax highlighting
+- [`colored`](https://pypi.org/project/colored/) for terminal color output
+
+## 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
+  -s SHORT, --short SHORT
+                        for add a short unformatted comment.
+  -vs, --VScode         Open the template file in VScode instead of nvim.
+  -np, --notepad        Open the template file in notepad instead of nvim.
+
+```
+
+### Examples
+
+```bash
+setjcomment 6552 -s "This is a short comment."
+setjcomment 6552 -vs # Opens the template file in VScode for editing.
+setjcomment 6552 -np # Opens the template file in Notepad for editing.
+```
+---
+
+## License
+
+See [LICENSE](LICENSE) for details.
+
+---
+
+## Author
+
+**Juan Jose Solorzano Carrillo** — juanjose.solorzano.c@gmail.com

setjcomment-1.1.1/README.md

@@ -0,0 +1,72 @@
+# setjcomment
+
+> A Jira comment management tool via terminal. Manage your JIRA issue comments directly from the terminal, using the REST API of JIRA. This tool allows you to add comments to JIRA issues using a template file for consistent formatting, and supports multiple editors for editing the comment content.
+
+`setjcomment` allows you to add comments to JIRA issues directly from your terminal, using a template file for consistent formatting.
+
+---
+
+## Features
+
+- **Add comments to JIRA issues** directly from the terminal
+- **Use a template file** for consistent comment formatting
+- **Supports multiple editors** (nvim, VScode, Notepad)
+- **Environment variable configuration** for JIRA server, username, and password
+- Works as a global CLI command after installation
+
+---
+
+## Installation
+
+```bash
+pip install setjcomment
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/your-username/setjcomment.git
+cd setjcomment
+pip install .
+```
+
+---
+
+## Dependencies
+- [`Pygments`](https://pypi.org/project/Pygments/) for syntax highlighting
+- [`colored`](https://pypi.org/project/colored/) for terminal color output
+
+## 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
+  -s SHORT, --short SHORT
+                        for add a short unformatted comment.
+  -vs, --VScode         Open the template file in VScode instead of nvim.
+  -np, --notepad        Open the template file in notepad instead of nvim.
+
+```
+
+### Examples
+
+```bash
+setjcomment 6552 -s "This is a short comment."
+setjcomment 6552 -vs # Opens the template file in VScode for editing.
+setjcomment 6552 -np # Opens the template file in Notepad for editing.
+```
+---
+
+## License
+
+See [LICENSE](LICENSE) for details.
+
+---
+
+## Author
+
+**Juan Jose Solorzano Carrillo** — juanjose.solorzano.c@gmail.com

setjcomment-1.1.1/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "setjcomment"
+version = "1.1.1"
+authors = [
+    { name="Juan Jose Solorzano", email="juanjose.solorzano.c@gmail.com" }
+]
+description = "A Jira comment management tool via terminal. Manage your JIRA issue comments directly from the terminal, using the REST API of JIRA. This tool allows you to add comments to JIRA issues using a template file for consistent formatting, and supports multiple editors for editing the comment content."
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+]
+
+# Right side: package_folder.module_file:function_name
+[project.scripts]
+setjcomment = "setjcomment.setjcomment:run"  # Creates the global 'setjcomment' terminal command!
+
+# Tells hatchling explicitly to look for your renamed directory inside src/
+[tool.hatch.build.targets.wheel]
+packages = ["src/setjcomment"]
+
+#i This section is for setuptools, which hatchling can also use. It specifies that any file matching *.txt in the mypackage directory should be included in the package data when building the wheel.
+[tool.setuptools.package-data]
+setjcomment = ["*.txt", "src/setjcomment/*.txt"]

setjcomment-1.1.1/src/setjcomment/__init__.py

@@ -0,0 +1 @@
+from .setjcomment import run

setjcomment-1.1.1/src/setjcomment/setjcomment.py

@@ -0,0 +1,83 @@
+import requests
+import os
+import subprocess
+import argparse
+import sys
+sys.stdout.reconfigure(encoding="utf-8")#type: ignore
+sys.stderr.reconfigure(encoding="utf-8")#type: ignore
+from requests.auth import HTTPBasicAuth
+from datetime import date
+from importlib import resources
+
+JIRA_SERVER = os.getenv("JIRA_SERVER","")
+USERNAME = os.getenv("JIRA_USERNAME","")
+PASSWORD = os.getenv("JIRA_PASSWORD","")
+TEMP_PATH = os.getenv("TEMP", "D:\\temp")
+TRACKING_TITLE = "PERSONAL TRACKING"
+TEMPLATE_FILE_NAME = "temp_comment.jira"
+TODAY = date.today().strftime("%d/%m/%Y")
+ISSUE_KEY = "SETV-%s"
+EDITOR = "nvim"
+URL = "https://{0}/rest/api/2/issue/{1}/comment"
+HEADERS = {"Accept": "application/json","Content-Type": "application/json"}
+PAYLOAD = {"body": ""}
+
+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("-s", "--short",required=False, default="", type=str, help="for add a short unformatted comment.")
+    parser.add_argument("-vs", "--VScode",action="store_true", default=False, help="Open the template file in VScode instead of nvim.")
+    parser.add_argument("-np", "--notepad", action="store_true", default=False, help="Open the template file in notepad instead of nvim.")
+    return parser.parse_args()
+
+def create_payload(cwd: str, args:argparse.Namespace) -> dict[str, str]:
+    body = ""
+    with open(f"{cwd}\\{TEMPLATE_FILE_NAME}", "r") as f:
+        lines = f.readlines()
+    with open(f"{TEMP_PATH}\\{TEMPLATE_FILE_NAME}", "w") as outputfile:
+        outputfile.writelines(lines)
+    if args.short:
+        body = str(args.short).replace(";", "\n")
+    else:
+        if args.VScode:
+            proc = subprocess.Popen(["c:\\LegacyApp\\VScode\\Code.exe", f"{TEMP_PATH}\\{TEMPLATE_FILE_NAME}"], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL) 
+            proc.wait()
+        elif args.notepad:
+            subprocess.call(["notepad", f"{TEMP_PATH}\\{TEMPLATE_FILE_NAME}"])
+        else:
+            subprocess.call([EDITOR, f"{TEMP_PATH}\\{TEMPLATE_FILE_NAME}"])
+        with open(f"{TEMP_PATH}\\{TEMPLATE_FILE_NAME}", "r") as f:
+            additional_comment = f.read()
+        os.remove(f"{TEMP_PATH}\\{TEMPLATE_FILE_NAME}")
+        for line in additional_comment.splitlines():
+            if line.__contains__("::DATE::"):
+                line = line.replace("::DATE::", TODAY)
+            if line.__contains__("----"):
+                line = line+"\n"
+            body += line + "\n"
+    return {"body": body}
+
+def connect_jira(payload: dict[str,str], args: argparse.Namespace):
+    url = URL.format(JIRA_SERVER, ISSUE_KEY % args.issue_id)
+    auth = HTTPBasicAuth(USERNAME, PASSWORD)
+    response = requests.post(url, auth=auth, headers=HEADERS, json=payload)
+    if response.status_code == 201:
+        print("Comment added successfully.")
+    else:
+        print("Failed to add comment. Status code:", response.status_code)
+        print("Response:", response.text)
+
+def run() -> None:
+    text_path = resources.files("setjcomment").joinpath(TEMPLATE_FILE_NAME)
+    if not text_path.is_file():
+        print(f"Template file '{TEMPLATE_FILE_NAME}' not found in the package resources.")
+        return
+    path = str(text_path.parent)#type: ignore
+    args = parse_args()
+    print(f"Using template file at: {str(path)}")
+    payload = create_payload(str(path), args)
+    connect_jira(payload, args)
+
+#This allows the script to be run directly, and also allows the 'run' function to be imported and used in other contexts (like testing).
+if __name__ == "__main__":
+    run()

setjcomment-1.1.1/src/setjcomment/temp_comment.jira

@@ -0,0 +1,13 @@
+h1. ::DATE::
+ * Task1 - *0.0h*
+
+
+----
+
+h1. Personal Tracking:
+
+{quote}
+TEXT
+    - Topic1: text
+    - Topic2: text
+{quote}