gmsg 0.1.4__tar.gz → 0.1.6__tar.gz

gmsg-0.1.6/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.3
+Name: gmsg
+Version: 0.1.6
+Summary: Generates git commit messages for you using AI.
+License: MIT
+Keywords: git,commit,ai
+Author: Shiyan Shirani
+Author-email: shiyan99s@gmail.com
+Requires-Python: >=3.9.5
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: cryptography (>=45.0.2,<46.0.0)
+Requires-Dist: google-genai (>=1.9.0,<2.0.0)
+Description-Content-Type: text/markdown
+
+# gmsg
+
+A command-line tool that automatically generates concise and meaningful Git commit messages using Google's Gemini model based on your staged changes.
+
+---
+
+## 🚀 Features
+
+* ✅ Detects if the current directory is a Git repository
+* ✅ Retrieves your staged changes via `git diff --cached`
+* ✅ Uses Gemini (for now) to generate a one-liner commit message
+* ✅ Allows you to:
+
+  * Accept the suggestion
+  * Edit the message in your preferred text editor
+  * Regenerate a new suggestion
+* ✅ Automatically commits the changes with your selected message
+
+---
+
+## 📦 Installation
+
+```bash
+pip install gmsg
+```
+
+---
+
+## 🛠️ Configuration
+
+Get your [Google Gemini API key](https://aistudio.google.com/app/apikey) if you don't have already.
+
+### 1. Set API key
+
+Enter your api key when package is used for the first time.
+
+```bash
+$ Enter your Gemini API KEY:
+```
+
+---
+
+## ⚙️ Usage
+
+1. Stage your changes:
+
+   ```bash
+   git add .
+   or 
+   git add <file>
+   ```
+
+2. Run the package:
+
+   ```bash
+   gmsg
+   ```
+
+3. Follow the prompts:
+
+   * Press `y/Y/enter` to commit with the suggested message
+   * Press `e` to edit the message in your default `$EDITOR` (e.g., `vim`)
+   * Press `n` to regenerate the commit message
+
+---
+
+## ✨ Example
+
+```bash
+$ git add some_file.py
+$ gmsg
+
+> Generate a one liner git commit message for these changes...
+> Added error handling in API response parser
+
+Do you want to continue with this message? [Y = yes / e = edit / n = no]: y
+Running: `git commit -m Added error handling in API response parser`
+Message committed to git. You can run `git commit --amend` to modify it.
+```
+
+---
+
+## 🧩 Requirements
+
+* Python 3.10+
+* Git installed and available in your system path
+---
+
+## 📍 Roadmap
+
+Here are some upcoming features and improvements planned for this project:
+* [ ] **CLI Arguments Support**
+  Add flags like `--gin` to mention 'git issue number' in the commit.
+
+* [ ] **CLI Arguments Support**
+  Add flags like `--dry-run` for non-interactive use.
+
+* [ ] **Multi-line Commit Messages**
+  Option to generate more descriptive, multi-line messages with summaries and bullet points.
+
+* [ ] **Better Diff Parsing**
+  Use syntax-aware parsing to improve prompt context and generate more accurate commit messages.
+
+* [ ] **Git Hook Integration**
+  Provide an installable Git commit hook that auto-runs this tool on `git commit`.
+
+* [ ] **Support for Other LLMs**
+  Add support for OpenAI's GPT, Claude, or local models using plugins/adapters.
+
+---
+
+
+## 📝 License
+
+MIT License. Feel free to use, modify, and contribute!
+
+---
+
+## 🤝 Contributing
+
+Pull requests are welcome. For major changes, open an issue first to discuss what you'd like to change.
+
+

gmsg-0.1.6/README.md

@@ -0,0 +1,122 @@
+# gmsg
+
+A command-line tool that automatically generates concise and meaningful Git commit messages using Google's Gemini model based on your staged changes.
+
+---
+
+## 🚀 Features
+
+* ✅ Detects if the current directory is a Git repository
+* ✅ Retrieves your staged changes via `git diff --cached`
+* ✅ Uses Gemini (for now) to generate a one-liner commit message
+* ✅ Allows you to:
+
+  * Accept the suggestion
+  * Edit the message in your preferred text editor
+  * Regenerate a new suggestion
+* ✅ Automatically commits the changes with your selected message
+
+---
+
+## 📦 Installation
+
+```bash
+pip install gmsg
+```
+
+---
+
+## 🛠️ Configuration
+
+Get your [Google Gemini API key](https://aistudio.google.com/app/apikey) if you don't have already.
+
+### 1. Set API key
+
+Enter your api key when package is used for the first time.
+
+```bash
+$ Enter your Gemini API KEY:
+```
+
+---
+
+## ⚙️ Usage
+
+1. Stage your changes:
+
+   ```bash
+   git add .
+   or 
+   git add <file>
+   ```
+
+2. Run the package:
+
+   ```bash
+   gmsg
+   ```
+
+3. Follow the prompts:
+
+   * Press `y/Y/enter` to commit with the suggested message
+   * Press `e` to edit the message in your default `$EDITOR` (e.g., `vim`)
+   * Press `n` to regenerate the commit message
+
+---
+
+## ✨ Example
+
+```bash
+$ git add some_file.py
+$ gmsg
+
+> Generate a one liner git commit message for these changes...
+> Added error handling in API response parser
+
+Do you want to continue with this message? [Y = yes / e = edit / n = no]: y
+Running: `git commit -m Added error handling in API response parser`
+Message committed to git. You can run `git commit --amend` to modify it.
+```
+
+---
+
+## 🧩 Requirements
+
+* Python 3.10+
+* Git installed and available in your system path
+---
+
+## 📍 Roadmap
+
+Here are some upcoming features and improvements planned for this project:
+* [ ] **CLI Arguments Support**
+  Add flags like `--gin` to mention 'git issue number' in the commit.
+
+* [ ] **CLI Arguments Support**
+  Add flags like `--dry-run` for non-interactive use.
+
+* [ ] **Multi-line Commit Messages**
+  Option to generate more descriptive, multi-line messages with summaries and bullet points.
+
+* [ ] **Better Diff Parsing**
+  Use syntax-aware parsing to improve prompt context and generate more accurate commit messages.
+
+* [ ] **Git Hook Integration**
+  Provide an installable Git commit hook that auto-runs this tool on `git commit`.
+
+* [ ] **Support for Other LLMs**
+  Add support for OpenAI's GPT, Claude, or local models using plugins/adapters.
+
+---
+
+
+## 📝 License
+
+MIT License. Feel free to use, modify, and contribute!
+
+---
+
+## 🤝 Contributing
+
+Pull requests are welcome. For major changes, open an issue first to discuss what you'd like to change.
+

{gmsg-0.1.4 → gmsg-0.1.6}/gmsg/api_key.py

@@ -1,5 +1,6 @@
 import sys
 import os
+import getpass
 
 from pathlib import Path
 
@@ -11,13 +12,13 @@ def get_or_set_api_key():
             print(
                 "Get your key from https://ai.google.dev/gemini-api/docs/api-key"
             )
-            key_inp = input("Enter your Gemini API KEY: ").strip()
-            with open(rc, 'w') as f:
-                f.write(key_inp)
+            key_inp = getpass.getpass("Enter your Gemini API KEY: ").strip()
+            with open(rc, "w") as file:
+                file.write(key_inp)
 
             return key_inp
 
-        with open(rc, 'r') as f:
+        with open(rc, "r") as f:
             return f.read().strip()
     except KeyboardInterrupt:
         sys.exit(0)

{gmsg-0.1.4 → gmsg-0.1.6}/gmsg/gmsg.py

@@ -4,7 +4,8 @@ import tempfile
 import subprocess
 from google import genai
 from pathlib import Path
-from .api_key import get_or_set_api_key
+# from .api_key import get_or_set_api_key
+from api_key import get_or_set_api_key
 
 GREEN = "\033[92m"
 RED = "\033[91m"
@@ -44,13 +45,14 @@ def trigger_query(query: str, api_key: str) -> str:
         client = genai.Client(api_key=api_key)
         msg = client.models.generate_content(model="gemini-2.0-flash",
                                              contents=query)
-        return msg.text
+        return msg.text.strip()
     except genai.errors.ClientError as error:
         if error.code == 400:
-            printt(dict(error="Gemini API key not valid, check ~/.gmsg"),
+            printt("Gemini API key is invalid, check ~/.gmsg",
                    is_success=False)
+            sys.exit(1)
         else:
-            printt(error, is_success=False)
+            print(error, is_success=False)
             sys.exit(1)
 
 
@@ -59,24 +61,25 @@ def cycle_through_messages(diff: str, api_key: str) -> bool:
     msg = trigger_query(query, api_key)
 
     while True:
-        printt(msg)
+        printt(msg + '\n')
         action = input(
-            "Do you want to continue with this message? [Y = yes / e = edit / n = no]: "
+            "Do you want to continue with this message? c(continue) / e(edit) / r(regenerate) / a(abort): "
         ).strip().lower()
-        if action in ("", "y", "Y"):
+        if action == "c":
             print(
                 f"Running: `git commit -m {msg}`\nMessage committed to git. You can run `git commit --amend` to modify it."
             )
 
             commit_message_to_git(msg)
             break
-        elif action in ("n", "N"):
+        elif action == "r":
             msg = trigger_query(query, api_key)
-        elif action in ("e", "E"):
+        elif action == "e":
             msg = edit_message_in_editor(msg)
-
+        elif action == "a":
+            sys.exit(1)
         else:
-            print("Invalid input. Please enter 'Y', 'e', or 'n'.")
+            print("warning: invalid input")
 
 
 def commit_message_to_git(generated_msg: str) -> str | None:
@@ -118,16 +121,16 @@ def printt(text: str, is_success: bool = True):
 
 def main():
     try:
+        user_api_key = get_or_set_api_key()
         if not is_git_repo():
-            printt("Not a git repository.", is_success=False)
+            printt("warning: not a git repository.", is_success=False)
             sys.exit(1)
 
         diff = git_diff()
         if not diff:
-            printt("No staged changes found.", is_success=False)
+            printt("warning: no staged changes found", is_success=False)
             sys.exit(1)
 
-        user_api_key = get_or_set_api_key()
         cycle_through_messages(diff, user_api_key)
 
     except KeyboardInterrupt:

gmsg-0.1.6/pyproject.toml

@@ -0,0 +1,25 @@
+[tool.poetry]
+name = "gmsg"
+version = "0.1.6"
+description = "Generates git commit messages for you using AI."
+authors = ["Shiyan Shirani <shiyan99s@gmail.com>"]
+license = "MIT"
+readme = "README.md"
+packages = [{ include = "gmsg" }]
+keywords = ["git", "commit", "ai"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License"
+]
+
+[tool.poetry.dependencies]
+python = ">=3.9.5"
+google-genai = ">=1.9.0,<2.0.0"
+cryptography = "^45.0.2"
+
+[tool.poetry.scripts]
+gmsg = "gmsg.gmsg:main"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

gmsg-0.1.4/PKG-INFO

@@ -1,18 +0,0 @@
-Metadata-Version: 2.3
-Name: gmsg
-Version: 0.1.4
-Summary: Generates git commit messages for you using AI.
-License: MIT
-Author: shiyan99s@gmail.com
-Requires-Python: >=3.9
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: google-genai (>=1.9.0,<2.0.0)
-Description-Content-Type: text/markdown
-
-

gmsg-0.1.4/pyproject.toml

@@ -1,21 +0,0 @@
-[project]
-name = "gmsg"
-version = "0.1.4"
-description = "Generates git commit messages for you using AI."
-authors = [
-    {name = "shiyan99s@gmail.com"}
-]
-license = {text = "MIT"}
-readme = "README.md"
-requires-python = ">=3.9"
-dependencies = [
-    "google-genai (>=1.9.0,<2.0.0)"
-]
-
-[project.scripts]
-gmsg = "gmsg.gmsg:main"
-
-
-[build-system]
-requires = ["poetry-core>=2.0.0,<3.0.0"]
-build-backend = "poetry.core.masonry.api"