setjtime 1.2.1__tar.gz

setjtime-1.2.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.

setjtime-1.2.1/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: setjtime
+Version: 1.2.1
+Summary: A tool to log time to JIRA issues directly from the terminal.
+Author-email: Juan Jose Solorzano <juanjose.solorzano.c@gmail.com>
+License-File: LICENSE
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# setjtime
+
+> A Jira time logger tool via terminal. 
+
+`setjtime` allows you to log time to JIRA issues directly from your terminal. It supports adding simple comments so you can provide context for the time logged. This tool uses the REST API of JIRA to interact with your JIRA server, and requires environment variables for configuration.
+---
+
+## Features
+  
+- **Log time to JIRA issues** directly from the terminal
+- **Add comments to JIRA issues** for context
+- **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/JuanJoseSolorzano/setjtime_project.git 
+cd setjtime_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     TIME    : Time spent (e.g., "2h", "30m").
+  -c COMMENT, --comment  COMMENT : Add a short unformatted comment [optional].
+
+```
+
+### Examples
+
+```bash
+setjcomment 6552 -s "This is a short comment."
+setjcomment 6552 -t "2h" # Logs 2 hours to the JIRA issue.
+setjcomment 6552 -c "This is a short comment." # Adds a short comment to the JIRA issue.
+```
+---
+
+## License
+
+See [LICENSE](LICENSE) for details.
+
+---
+
+## Author
+
+**Juan Jose Solorzano Carrillo** — juanjose.solorzano.c@gmail.com

setjtime-1.2.1/README.md

@@ -0,0 +1,68 @@
+# setjtime
+
+> A Jira time logger tool via terminal. 
+
+`setjtime` allows you to log time to JIRA issues directly from your terminal. It supports adding simple comments so you can provide context for the time logged. This tool uses the REST API of JIRA to interact with your JIRA server, and requires environment variables for configuration.
+---
+
+## Features
+  
+- **Log time to JIRA issues** directly from the terminal
+- **Add comments to JIRA issues** for context
+- **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/JuanJoseSolorzano/setjtime_project.git 
+cd setjtime_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     TIME    : Time spent (e.g., "2h", "30m").
+  -c COMMENT, --comment  COMMENT : Add a short unformatted comment [optional].
+
+```
+
+### Examples
+
+```bash
+setjcomment 6552 -s "This is a short comment."
+setjcomment 6552 -t "2h" # Logs 2 hours to the JIRA issue.
+setjcomment 6552 -c "This is a short comment." # Adds a short comment to the JIRA issue.
+```
+---
+
+## License
+
+See [LICENSE](LICENSE) for details.
+
+---
+
+## Author
+
+**Juan Jose Solorzano Carrillo** — juanjose.solorzano.c@gmail.com

setjtime-1.2.1/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "setjtime"
+version = "1.2.1"
+authors = [
+    { name="Juan Jose Solorzano", email="juanjose.solorzano.c@gmail.com" }
+]
+description = "A tool to log time to JIRA issues directly from the terminal."
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = [
+]
+
+# Right side: package_folder.module_file:function_name
+[project.scripts]
+setjtime = "setjtime.setjtime:run"  # Creates the global 'setjtime' terminal command!
+
+# Tells hatchling explicitly to look for your renamed directory inside src/
+[tool.hatch.build.targets.wheel]
+packages = ["src/setjtime"]

setjtime-1.2.1/src/setjtime/__init__.py

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

setjtime-1.2.1/src/setjtime/setjtime.py

@@ -0,0 +1,49 @@
+import requests
+import os
+import argparse
+from requests.auth import HTTPBasicAuth
+from datetime import date
+import sys
+sys.stdout.reconfigure(encoding="utf-8")#type: ignore
+sys.stderr.reconfigure(encoding="utf-8")#type: ignore
+
+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": ""}
+
+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("-t", "--time",type=str,required=True, default="0h", help="Time spent to log, e.g., 1h, 30m, 2d, etc.")
+    parser.add_argument("-c", "--comment",type=str,required=False, default="", help="for add a short unformatted comment.")
+    return parser.parse_args()
+
+def create_payload(args:argparse.Namespace) -> dict[str, str]:
+    body = ""
+    spent_time = args.time
+    if args.comment:
+        body = str(args.comment).replace(";", "\n")
+    return {"timeSpent": spent_time,"comment": f" [{spent_time}] - {body} Logged on *{TODAY}*"}
+
+def connect_jira(payload: dict[str,str],issue_id:str):
+    url = f"https://{JIRA_SERVER}/rest/api/2/issue/{ISSUE_KEY % issue_id}/worklog"
+    auth = HTTPBasicAuth(USERNAME, PASSWORD)
+    response = requests.post(url, auth=auth, headers=HEADERS, json=payload)
+    if response.status_code == 201:
+        print("Worklog entry added successfully.")
+    else:
+        print("Failed to add worklog entry. Status code:", response.status_code)
+        print(response.text)
+
+def run():
+    args = parse_args()
+    payload = create_payload(args)
+    connect_jira(payload,args.issue_id)
+
+if __name__ == "__main__":
+     run()