commit-msg-ai 0.2.1__py3-none-any.whl

commit_msg_ai/__init__.py

@@ -0,0 +1,3 @@
+"""commit-msg-ai - Generate commit messages from staged changes using a local LLM."""
+
+__version__ = "0.2.1"

commit_msg_ai/main.py

@@ -0,0 +1,202 @@
+import argparse
+import json
+import subprocess
+import sys
+from pathlib import Path
+
+import httpx
+
+SYSTEM_PROMPT = """\
+You are a commit message generator. Given a git diff and file list, write a clear and concise commit message.
+
+Allowed prefixes (use ONLY these, never add a scope in parentheses):
+- feat: for new features or functionality
+- fix: for bug fixes
+- bc: for breaking changes
+
+Rules:
+- Write a SINGLE line: prefix and short summary, max 72 characters. Example: "feat: add user authentication"
+- NEVER use scopes like feat(app): or fix(core): — just "feat:", "fix:", or "bc:" directly.
+- NEVER write multi-line messages. Output exactly ONE line, no body, no bullets.
+- Always consider the FULL file list to understand the scope, especially if the diff is truncated.
+- The summary must capture the overall intent, not list individual changes.
+- Write in English.
+- Focus on WHY the change was made, not just WHAT changed.
+- Do NOT wrap the message in quotes or markdown.
+- Do NOT include any text other than the commit message itself.\
+"""
+
+DEFAULT_MODEL = "llama3.2"
+DEFAULT_URL = "http://localhost:11434"
+CONFIG_PATH = Path.home() / ".config" / "commit-msg-ai" / "config.json"
+
+
+def load_config() -> dict:
+    if CONFIG_PATH.exists():
+        try:
+            return json.loads(CONFIG_PATH.read_text())
+        except (json.JSONDecodeError, OSError):
+            return {}
+    return {}
+
+
+def save_config(config: dict) -> None:
+    CONFIG_PATH.parent.mkdir(parents=True, exist_ok=True)
+    CONFIG_PATH.write_text(json.dumps(config, indent=2) + "\n")
+
+
+def get_staged_diff() -> str:
+    result = subprocess.run(
+        ["git", "diff", "--staged"],
+        capture_output=True,
+        text=True,
+    )
+    if result.returncode != 0:
+        print(f"Error running git diff: {result.stderr}", file=sys.stderr)
+        sys.exit(1)
+    return result.stdout
+
+
+def get_staged_files() -> str:
+    result = subprocess.run(
+        ["git", "diff", "--staged", "--name-status"],
+        capture_output=True,
+        text=True,
+    )
+    return result.stdout.strip()
+
+
+def generate_message(diff: str, files: str, model: str, url: str) -> str:
+    max_diff_chars = 12000
+    truncated = len(diff) > max_diff_chars
+
+    parts = [f"Files changed:\n{files}\n"]
+    if truncated:
+        parts.append(f"Diff (truncated, showing first {max_diff_chars} chars):\n{diff[:max_diff_chars]}")
+        parts.append("\n\nThe diff was truncated. Use the file list above to understand the full scope of changes.")
+    else:
+        parts.append(f"Diff:\n{diff}")
+
+    user_prompt = "Generate a commit message for these changes:\n\n" + "\n".join(parts)
+
+    try:
+        response = httpx.post(
+            f"{url}/api/chat",
+            json={
+                "model": model,
+                "messages": [
+                    {"role": "system", "content": SYSTEM_PROMPT},
+                    {"role": "user", "content": user_prompt},
+                ],
+                "stream": False,
+            },
+            timeout=60.0,
+        )
+        response.raise_for_status()
+    except httpx.ConnectError:
+        print(
+            "Error: Cannot connect to Ollama. Is it running?\n"
+            f"Expected at: {url}",
+            file=sys.stderr,
+        )
+        sys.exit(1)
+    except httpx.HTTPStatusError as e:
+        print(f"Error from Ollama: {e.response.text}", file=sys.stderr)
+        sys.exit(1)
+
+    return response.json()["message"]["content"].strip()
+
+
+def confirm(prompt: str) -> bool:
+    answer = input(f"{prompt} [Y/n] ").strip().lower()
+    return answer in ("", "y", "yes")
+
+
+def do_commit(message: str) -> None:
+    result = subprocess.run(
+        ["git", "commit", "-m", message],
+        capture_output=True,
+        text=True,
+    )
+    if result.returncode != 0:
+        print(f"Commit failed: {result.stderr}", file=sys.stderr)
+        sys.exit(1)
+    print(result.stdout)
+
+
+def cmd_config(args):
+    config = load_config()
+
+    if args.key is None:
+        if not config:
+            print("No config set. Use: commit-msg-ai config model <value>")
+        else:
+            for k, v in config.items():
+                print(f"{k} = {v}")
+        return
+
+    if args.value is None:
+        value = config.get(args.key)
+        if value is None:
+            print(f"{args.key} is not set")
+        else:
+            print(f"{args.key} = {value}")
+        return
+
+    config[args.key] = args.value
+    save_config(config)
+    print(f"{args.key} = {args.value}")
+
+
+def cmd_run(args):
+    config = load_config()
+    model = args.model or config.get("model", DEFAULT_MODEL)
+    url = args.url or config.get("url", DEFAULT_URL)
+
+    diff = get_staged_diff()
+    if not diff.strip():
+        print("No staged changes found. Stage your changes with `git add` first.")
+        sys.exit(1)
+
+    files = get_staged_files()
+    print(f"Staged files:\n{files}\n")
+    print(f"Generating commit message with {model}...\n")
+
+    message = generate_message(diff, files, model, url)
+
+    print("─" * 50)
+    print(message)
+    print("─" * 50)
+    print()
+
+    if confirm("Commit with this message?"):
+        do_commit(message)
+    else:
+        print("Aborted.")
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Generate a commit message from staged changes using a local LLM.",
+    )
+    sub = parser.add_subparsers(dest="command")
+
+    # config subcommand
+    cfg = sub.add_parser("config", help="Get or set config values (model, url)")
+    cfg.add_argument("key", nargs="?", help="Config key (model, url)")
+    cfg.add_argument("value", nargs="?", help="Value to set")
+
+    # Default run flags (also work without subcommand)
+    parser.add_argument("--model", default=None, help="Ollama model to use")
+    parser.add_argument("--url", default=None, help="Ollama server URL")
+
+    args = parser.parse_args()
+
+    if args.command == "config":
+        cmd_config(args)
+    else:
+        cmd_run(args)
+
+
+if __name__ == "__main__":
+    main()

commit_msg_ai-0.2.1.dist-info/METADATA

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: commit-msg-ai
+Version: 0.2.1
+Summary: Generate commit messages from staged changes using a local LLM via Ollama
+Project-URL: Homepage, https://xavimf87.github.io/commit-msg-ai
+Project-URL: Repository, https://github.com/xavimf87/commit-msg-ai
+Project-URL: Issues, https://github.com/xavimf87/commit-msg-ai/issues
+Author: Xavi Martínez
+License-Expression: MIT
+Keywords: ai,cli,commit,git,llm,ollama
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+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
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.27
+Description-Content-Type: text/markdown
+
+# commit-msg-ai
+
+Generate commit messages from your staged changes using a local LLM via [Ollama](https://ollama.com). No API keys, no cloud — everything runs on your machine.
+
+## Getting started
+
+### 1. Install and set up Ollama
+
+commit-msg-ai requires [Ollama](https://ollama.com) to run language models locally. Install it first:
+
+**macOS:**
+
+```bash
+brew install ollama
+```
+
+**Linux:**
+
+```bash
+curl -fsSL https://ollama.com/install.sh | sh
+```
+
+**Windows:** Download the installer from [ollama.com/download](https://ollama.com/download).
+
+Once installed, start the Ollama server:
+
+```bash
+ollama serve
+```
+
+> On macOS, Ollama runs automatically in the background after installation. You can skip this step if you see the Ollama icon in your menu bar.
+
+### 2. Choose a model
+
+You need at least one model downloaded. See what's available on your machine:
+
+```bash
+ollama list
+```
+
+If the list is empty, pull a model. Some good options for commit message generation:
+
+```bash
+# Lightweight and fast (~2GB)
+ollama pull llama3.2
+
+# Good for code understanding (~4.7GB)
+ollama pull qwen2.5-coder
+
+# Small and capable (~2.3GB)
+ollama pull mistral
+```
+
+You can browse all available models at [ollama.com/library](https://ollama.com/library).
+
+### 3. Install commit-msg-ai
+
+**With pipx (recommended):**
+
+```bash
+pipx install git+https://github.com/YOUR_USER/commit-msg-ai.git
+```
+
+**With pip:**
+
+```bash
+pip install git+https://github.com/YOUR_USER/commit-msg-ai.git
+```
+
+### 4. Configure your model
+
+By default commit-msg-ai uses `llama3.2`. If you pulled a different model, set it as default:
+
+```bash
+commit-msg-ai config model qwen2.5-coder
+```
+
+Verify your config:
+
+```bash
+commit-msg-ai config
+```
+
+### 5. Use it
+
+```bash
+git add .
+commit-msg-ai
+```
+
+```
+Staged files:
+M  src/auth.py
+A  src/middleware.py
+
+Generating commit message with qwen2.5-coder...
+
+──────────────────────────────────────────────────
+feat: add JWT authentication middleware
+──────────────────────────────────────────────────
+
+Commit with this message? [Y/n] y
+[main 3a1b2c3] feat: add JWT authentication middleware
+ 2 files changed, 45 insertions(+), 3 deletions(-)
+```
+
+That's it.
+
+## Configuration
+
+commit-msg-ai stores config in `~/.config/commit-msg-ai/config.json`.
+
+```bash
+# Set default model
+commit-msg-ai config model mistral
+
+# Set Ollama server URL (useful for remote setups)
+commit-msg-ai config url http://192.168.1.50:11434
+
+# View all config
+commit-msg-ai config
+
+# View a single value
+commit-msg-ai config model
+```
+
+Override any config for a single run with flags:
+
+```bash
+commit-msg-ai --model codellama
+commit-msg-ai --url http://other-server:11434
+```
+
+## Commit message format
+
+commit-msg-ai generates messages with only three prefixes:
+
+- `feat:` new features
+- `fix:` bug fixes
+- `bc:` breaking changes
+
+## Requirements
+
+- Python 3.9+
+- [Ollama](https://ollama.com) running locally (or on a reachable server)
+- At least one model pulled (`ollama pull llama3.2`)

commit_msg_ai-0.2.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+commit_msg_ai/__init__.py,sha256=2RngYNd1xDw-wUVQ_Bn-kQ14XuznUSrhvS7nveAhCnE,109
+commit_msg_ai/main.py,sha256=s2ZD_AJJL8Q7Jl6A7g-74F9bdHEMv8_8BXZvKNmB4hs,5967
+commit_msg_ai-0.2.1.dist-info/METADATA,sha256=VG5VdLICyjkjyWppPeCkcHwFpikEoNDQFMAbQRHBMXc,4223
+commit_msg_ai-0.2.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+commit_msg_ai-0.2.1.dist-info/entry_points.txt,sha256=FUYPHqtB2XCNcmavUeuDBnsPXr_eh-A1tl8rsHap2MA,58
+commit_msg_ai-0.2.1.dist-info/RECORD,,

commit_msg_ai-0.2.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

commit_msg_ai-0.2.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+commit-msg-ai = commit_msg_ai.main:main