git-commit-message 0.7.0__tar.gz → 0.8.1__tar.gz

{git_commit_message-0.7.0 → git_commit_message-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-message
-Version: 0.7.0
+Version: 0.8.1
 Summary: Generate Git commit messages from staged changes using LLM
 Maintainer-email: Mina Her <minacle@live.com>
 License: This is free and unencumbered software released into the public domain.
@@ -45,16 +45,22 @@ Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 Requires-Dist: babel>=2.17.0
 Requires-Dist: google-genai>=1.56.0
+Requires-Dist: ollama>=0.4.0
 Requires-Dist: openai>=2.6.1
 Requires-Dist: tiktoken>=0.12.0
 
 # git-commit-message
 
-Staged changes -> GPT commit message generator.
+Generate a commit message from your staged changes using OpenAI, Google Gemini, or Ollama.
 
 [![asciicast](https://asciinema.org/a/jk0phFqNnc5vaCiIZEYBwZOyN.svg)](https://asciinema.org/a/jk0phFqNnc5vaCiIZEYBwZOyN)
 
-## Install (PyPI)
+## Requirements
+
+- Python 3.13+
+- A Git repo with staged changes (`git add ...`) (or use `--amend` even if nothing is staged)
+
+## Install
 
 Install the latest released version from PyPI:
 
@@ -78,19 +84,43 @@ Quick check:
 git-commit-message --help
 ```
 
-Set your API key (POSIX sh):
+## Setup
+
+### OpenAI
 
 ```sh
 export OPENAI_API_KEY="sk-..."
 ```
 
-Or for the Google provider:
+### Google Gemini
 
 ```sh
 export GOOGLE_API_KEY="..."
 ```
 
-Note (fish): In fish, set it as follows.
+### Ollama (local models)
+
+1. Install Ollama: https://ollama.ai
+2. Start the server:
+
+```sh
+ollama serve
+```
+
+3. Pull a model:
+
+```sh
+ollama pull mistral
+```
+
+Optional: set defaults:
+
+```sh
+export GIT_COMMIT_MESSAGE_PROVIDER=ollama
+export OLLAMA_MODEL=mistral
+```
+
+Note (fish):
 
 ```fish
 set -x OPENAI_API_KEY "sk-..."
@@ -104,96 +134,130 @@ python -m pip install -e .
 
 ## Usage
 
-- Print commit message only:
+Generate and print a commit message:
 
 ```sh
 git add -A
 git-commit-message "optional extra context about the change"
 ```
 
-- Force single-line subject only:
+Generate a single-line subject only:
 
 ```sh
 git-commit-message --one-line "optional context"
 ```
 
-- Select provider (default: openai):
+Select provider:
 
 ```sh
-git-commit-message --provider openai "optional context"
+# OpenAI (default)
+git-commit-message --provider openai
+
+# Google Gemini (via google-genai)
+git-commit-message --provider google
+
+# Ollama
+git-commit-message --provider ollama
+```
+
+Commit immediately (optionally open editor):
+
+```sh
+git-commit-message --commit "refactor parser for speed"
+git-commit-message --commit --edit "refactor parser for speed"
 ```
 
-- Select provider (Google Gemini via google-genai):
+Amend the previous commit:
 
 ```sh
-git-commit-message --provider google "optional context"
+# print only (useful for pasting into a GUI editor)
+git-commit-message --amend "optional context"
+
+# amend immediately
+git-commit-message --commit --amend "optional context"
+
+# amend immediately, but open editor for final tweaks
+git-commit-message --commit --amend --edit "optional context"
 ```
 
-- Limit subject length (default 72):
+Limit subject length:
 
 ```sh
-git-commit-message --one-line --max-length 50 "optional context"
+git-commit-message --one-line --max-length 50
 ```
 
-- Chunk long diffs by token budget (0 = single chunk + summary, -1 = disable chunking):
+Chunk/summarise long diffs by token budget:
 
 ```sh
 # force a single summary pass over the whole diff (default)
-git-commit-message --chunk-tokens 0 "optional context"
+git-commit-message --chunk-tokens 0
 
 # chunk the diff into ~4000-token pieces before summarising
-git-commit-message --chunk-tokens 4000 "optional context"
+git-commit-message --chunk-tokens 4000
 
 # disable summarisation and use the legacy one-shot prompt
-git-commit-message --chunk-tokens -1 "optional context"
+git-commit-message --chunk-tokens -1
 ```
 
-- Commit immediately with editor:
+Select output language/locale (IETF language tag):
 
 ```sh
-git-commit-message --commit --edit "refactor parser for speed"
+git-commit-message --language en-US
+git-commit-message --language ko-KR
+git-commit-message --language ja-JP
 ```
 
-- Print debug info (prompt/response + token usage):
+Print debug info:
 
 ```sh
-git-commit-message --debug "optional context"
+git-commit-message --debug
 ```
 
-- Select output language/locale (default: en-GB):
+Configure Ollama host (if running on a different machine):
 
 ```sh
-# American English
-git-commit-message --language en-US "optional context"
+git-commit-message --provider ollama --host http://192.168.1.100:11434
+```
 
-# Korean
-git-commit-message --language ko-KR
+## Options
 
-# Japanese
-git-commit-message --language ja-JP
-```
+- `--provider {openai,google,ollama}`: provider to use (default: `openai`)
+- `--model MODEL`: model override (provider-specific)
+- `--language TAG`: output language/locale (default: `en-GB`)
+- `--one-line`: output subject only
+- `--max-length N`: max subject length (default: 72)
+- `--chunk-tokens N`: token budget per diff chunk (`0` = single summary pass, `-1` disables summarisation)
+- `--debug`: print request/response details
+- `--commit`: run `git commit -m <message>`
+- `--amend`: generate a message suitable for amending the previous commit (diff is from the amended commit's parent to the staged index; if nothing is staged, this effectively becomes the diff introduced by `HEAD`)
+- `--edit`: with `--commit`, open editor for final message
+- `--host URL`: host URL for providers like Ollama (default: `http://localhost:11434`)
+
+## Environment variables
 
-Notes:
+Required:
 
-- The model is instructed to write using the selected language/locale.
-- In multi-line mode, the only allowed label ("Rationale:") is also translated into the target language.
+- `OPENAI_API_KEY`: when provider is `openai`
+- `GOOGLE_API_KEY`: when provider is `google`
 
-Environment:
+Optional:
 
-- `OPENAI_API_KEY`: required when provider is `openai`
-- `GOOGLE_API_KEY`: required when provider is `google`
-- `GIT_COMMIT_MESSAGE_PROVIDER`: optional (default: `openai`). `--provider` overrides this value.
-- `GIT_COMMIT_MESSAGE_MODEL`: optional model override (defaults: `openai` -> `gpt-5-mini`, `google` -> `gemini-2.5-flash`)
-- `OPENAI_MODEL`: optional OpenAI-only model override
-- `GIT_COMMIT_MESSAGE_LANGUAGE`: optional (default: `en-GB`)
-- `GIT_COMMIT_MESSAGE_CHUNK_TOKENS`: optional token budget per diff chunk (default: 0 = single chunk + summary; -1 disables summarisation)
+- `GIT_COMMIT_MESSAGE_PROVIDER`: default provider (`openai` by default). `--provider` overrides this.
+- `GIT_COMMIT_MESSAGE_MODEL`: model override for any provider. `--model` overrides this.
+- `OPENAI_MODEL`: OpenAI-only model override (used if `--model`/`GIT_COMMIT_MESSAGE_MODEL` are not set)
+- `OLLAMA_MODEL`: Ollama-only model override (used if `--model`/`GIT_COMMIT_MESSAGE_MODEL` are not set)
+- `OLLAMA_HOST`: Ollama server URL (default: `http://localhost:11434`)
+- `GIT_COMMIT_MESSAGE_LANGUAGE`: default language/locale (default: `en-GB`)
+- `GIT_COMMIT_MESSAGE_CHUNK_TOKENS`: default chunk token budget (default: `0`)
 
-Notes:
+Default models (if not overridden):
 
-- If token counting fails for your provider while chunking, try `--chunk-tokens 0` (default) or `--chunk-tokens -1`.
+- OpenAI: `gpt-5-mini`
+- Google: `gemini-2.5-flash`
+- Ollama: `gpt-oss:20b`
 
-## AI‑generated code notice
+## AI-generated code notice
 
 Parts of this project were created with assistance from AI tools (e.g. large language models).
-All AI‑assisted contributions were reviewed and adapted by maintainers before inclusion.
+All AI-assisted contributions were reviewed and adapted by maintainers before inclusion.
 If you need provenance for specific changes, please refer to the Git history and commit messages.

git_commit_message-0.8.1/README.md

@@ -0,0 +1,212 @@
+# git-commit-message
+
+Generate a commit message from your staged changes using OpenAI, Google Gemini, or Ollama.
+
+[![asciicast](https://asciinema.org/a/jk0phFqNnc5vaCiIZEYBwZOyN.svg)](https://asciinema.org/a/jk0phFqNnc5vaCiIZEYBwZOyN)
+
+## Requirements
+
+- Python 3.13+
+- A Git repo with staged changes (`git add ...`) (or use `--amend` even if nothing is staged)
+
+## Install
+
+Install the latest released version from PyPI:
+
+```sh
+# User environment (recommended)
+python -m pip install --user git-commit-message
+
+# Or system/virtualenv as appropriate
+python -m pip install git-commit-message
+
+# Or with pipx for isolated CLI installs
+pipx install git-commit-message
+
+# Upgrade to the newest version
+python -m pip install --upgrade git-commit-message
+```
+
+Quick check:
+
+```sh
+git-commit-message --help
+```
+
+## Setup
+
+### OpenAI
+
+```sh
+export OPENAI_API_KEY="sk-..."
+```
+
+### Google Gemini
+
+```sh
+export GOOGLE_API_KEY="..."
+```
+
+### Ollama (local models)
+
+1. Install Ollama: https://ollama.ai
+2. Start the server:
+
+```sh
+ollama serve
+```
+
+3. Pull a model:
+
+```sh
+ollama pull mistral
+```
+
+Optional: set defaults:
+
+```sh
+export GIT_COMMIT_MESSAGE_PROVIDER=ollama
+export OLLAMA_MODEL=mistral
+```
+
+Note (fish):
+
+```fish
+set -x OPENAI_API_KEY "sk-..."
+```
+
+## Install (editable)
+
+```sh
+python -m pip install -e .
+```
+
+## Usage
+
+Generate and print a commit message:
+
+```sh
+git add -A
+git-commit-message "optional extra context about the change"
+```
+
+Generate a single-line subject only:
+
+```sh
+git-commit-message --one-line "optional context"
+```
+
+Select provider:
+
+```sh
+# OpenAI (default)
+git-commit-message --provider openai
+
+# Google Gemini (via google-genai)
+git-commit-message --provider google
+
+# Ollama
+git-commit-message --provider ollama
+```
+
+Commit immediately (optionally open editor):
+
+```sh
+git-commit-message --commit "refactor parser for speed"
+git-commit-message --commit --edit "refactor parser for speed"
+```
+
+Amend the previous commit:
+
+```sh
+# print only (useful for pasting into a GUI editor)
+git-commit-message --amend "optional context"
+
+# amend immediately
+git-commit-message --commit --amend "optional context"
+
+# amend immediately, but open editor for final tweaks
+git-commit-message --commit --amend --edit "optional context"
+```
+
+Limit subject length:
+
+```sh
+git-commit-message --one-line --max-length 50
+```
+
+Chunk/summarise long diffs by token budget:
+
+```sh
+# force a single summary pass over the whole diff (default)
+git-commit-message --chunk-tokens 0
+
+# chunk the diff into ~4000-token pieces before summarising
+git-commit-message --chunk-tokens 4000
+
+# disable summarisation and use the legacy one-shot prompt
+git-commit-message --chunk-tokens -1
+```
+
+Select output language/locale (IETF language tag):
+
+```sh
+git-commit-message --language en-US
+git-commit-message --language ko-KR
+git-commit-message --language ja-JP
+```
+
+Print debug info:
+
+```sh
+git-commit-message --debug
+```
+
+Configure Ollama host (if running on a different machine):
+
+```sh
+git-commit-message --provider ollama --host http://192.168.1.100:11434
+```
+
+## Options
+
+- `--provider {openai,google,ollama}`: provider to use (default: `openai`)
+- `--model MODEL`: model override (provider-specific)
+- `--language TAG`: output language/locale (default: `en-GB`)
+- `--one-line`: output subject only
+- `--max-length N`: max subject length (default: 72)
+- `--chunk-tokens N`: token budget per diff chunk (`0` = single summary pass, `-1` disables summarisation)
+- `--debug`: print request/response details
+- `--commit`: run `git commit -m <message>`
+- `--amend`: generate a message suitable for amending the previous commit (diff is from the amended commit's parent to the staged index; if nothing is staged, this effectively becomes the diff introduced by `HEAD`)
+- `--edit`: with `--commit`, open editor for final message
+- `--host URL`: host URL for providers like Ollama (default: `http://localhost:11434`)
+
+## Environment variables
+
+Required:
+
+- `OPENAI_API_KEY`: when provider is `openai`
+- `GOOGLE_API_KEY`: when provider is `google`
+
+Optional:
+
+- `GIT_COMMIT_MESSAGE_PROVIDER`: default provider (`openai` by default). `--provider` overrides this.
+- `GIT_COMMIT_MESSAGE_MODEL`: model override for any provider. `--model` overrides this.
+- `OPENAI_MODEL`: OpenAI-only model override (used if `--model`/`GIT_COMMIT_MESSAGE_MODEL` are not set)
+- `OLLAMA_MODEL`: Ollama-only model override (used if `--model`/`GIT_COMMIT_MESSAGE_MODEL` are not set)
+- `OLLAMA_HOST`: Ollama server URL (default: `http://localhost:11434`)
+- `GIT_COMMIT_MESSAGE_LANGUAGE`: default language/locale (default: `en-GB`)
+- `GIT_COMMIT_MESSAGE_CHUNK_TOKENS`: default chunk token budget (default: `0`)
+
+Default models (if not overridden):
+
+- OpenAI: `gpt-5-mini`
+- Google: `gemini-2.5-flash`
+- Ollama: `gpt-oss:20b`
+
+## AI-generated code notice
+
+Parts of this project were created with assistance from AI tools (e.g. large language models).
+All AI-assisted contributions were reviewed and adapted by maintainers before inclusion.
+If you need provenance for specific changes, please refer to the Git history and commit messages.

{git_commit_message-0.7.0 → git_commit_message-0.8.1}/pyproject.toml

@@ -1,12 +1,13 @@
 [project]
 name = "git-commit-message"
-version = "0.7.0"
+version = "0.8.1"
 description = "Generate Git commit messages from staged changes using LLM"
 readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [
 	"babel>=2.17.0",
 	"google-genai>=1.56.0",
+	"ollama>=0.4.0",
 	"openai>=2.6.1",
 	"tiktoken>=0.12.0",
 ]

{git_commit_message-0.7.0 → git_commit_message-0.8.1}/src/git_commit_message/_cli.py

@@ -17,7 +17,9 @@ from ._git import (
     commit_with_message,
     get_repo_root,
     get_staged_diff,
+    has_head_commit,
     has_staged_changes,
+    resolve_amend_base_ref,
 )
 from ._llm import (
     CommitMessageResult,
@@ -27,6 +29,40 @@ from ._llm import (
 )
 
 
+class CliArgs(Namespace):
+    __slots__ = (
+        "description",
+        "commit",
+        "amend",
+        "edit",
+        "provider",
+        "model",
+        "language",
+        "debug",
+        "one_line",
+        "max_length",
+        "chunk_tokens",
+        "host",
+    )
+
+    def __init__(
+        self,
+        /,
+    ) -> None:
+        self.description: str | None = None
+        self.commit: bool = False
+        self.amend: bool = False
+        self.edit: bool = False
+        self.provider: str | None = None
+        self.model: str | None = None
+        self.language: str | None = None
+        self.debug: bool = False
+        self.one_line: bool = False
+        self.max_length: int | None = None
+        self.chunk_tokens: int | None = None
+        self.host: str | None = None
+
+
 def _env_chunk_tokens_default() -> int | None:
     """Return chunk token default from env if valid, else None."""
 
@@ -67,6 +103,16 @@ def _build_parser() -> ArgumentParser:
         help="Commit immediately with the generated message.",
     )
 
+    parser.add_argument(
+        "--amend",
+        action="store_true",
+        help=(
+            "Generate a message suitable for amending the previous commit. "
+            "When set, the diff is computed from the amended commit's parent to the staged index. "
+            "Use with '--commit' to run the amend, or omit '--commit' to print the message only."
+        ),
+    )
+
     parser.add_argument(
         "--edit",
         action="store_true",
@@ -87,7 +133,7 @@ def _build_parser() -> ArgumentParser:
         "--model",
         default=None,
         help=(
-            "Model name to use. If unspecified, uses GIT_COMMIT_MESSAGE_MODEL or a provider-specific default (openai: gpt-5-mini; google: gemini-2.5-flash)."
+            "Model name to use. If unspecified, uses GIT_COMMIT_MESSAGE_MODEL or a provider-specific default (openai: gpt-5-mini; google: gemini-2.5-flash; ollama: gpt-oss:20b)."
         ),
     )
 
@@ -134,11 +180,21 @@ def _build_parser() -> ArgumentParser:
         ),
     )
 
+    parser.add_argument(
+        "--host",
+        dest="host",
+        default=None,
+        help=(
+            "Host URL for API providers like Ollama (default: http://localhost:11434). "
+            "You may also set OLLAMA_HOST for Ollama."
+        ),
+    )
+
     return parser
 
 
 def _run(
-    args: Namespace,
+    args: CliArgs,
     /,
 ) -> int:
     """Main execution logic.
@@ -156,11 +212,19 @@ def _run(
 
     repo_root: Path = get_repo_root()
 
-    if not has_staged_changes(repo_root):
-        print("No staged changes. Run 'git add' and try again.", file=stderr)
-        return 2
+    if args.amend:
+        if not has_head_commit(repo_root):
+            print("Cannot amend: the repository has no commits yet.", file=stderr)
+            return 2
+
+        base_ref = resolve_amend_base_ref(repo_root)
+        diff_text: str = get_staged_diff(repo_root, base_ref=base_ref)
+    else:
+        if not has_staged_changes(repo_root):
+            print("No staged changes. Run 'git add' and try again.", file=stderr)
+            return 2
 
-    diff_text: str = get_staged_diff(repo_root)
+        diff_text = get_staged_diff(repo_root)
 
     hint: str | None = args.description if isinstance(args.description, str) else None
 
@@ -177,11 +241,12 @@ def _run(
                 diff_text,
                 hint,
                 args.model,
-                getattr(args, "one_line", False),
-                getattr(args, "max_length", None),
-                getattr(args, "language", None),
+                args.one_line,
+                args.max_length,
+                args.language,
                 chunk_tokens,
-                getattr(args, "provider", None),
+                args.provider,
+                args.host,
             )
             message = result.message
         else:
@@ -189,11 +254,12 @@ def _run(
                 diff_text,
                 hint,
                 args.model,
-                getattr(args, "one_line", False),
-                getattr(args, "max_length", None),
-                getattr(args, "language", None),
+                args.one_line,
+                args.max_length,
+                args.language,
                 chunk_tokens,
-                getattr(args, "provider", None),
+                args.provider,
+                args.host,
             )
     except UnsupportedProviderError as exc:
         print(str(exc), file=stderr)
@@ -203,7 +269,7 @@ def _run(
         return 3
 
     # Option: force single-line message
-    if getattr(args, "one_line", False):
+    if args.one_line:
         # Use the first non-empty line only
         for line in (ln.strip() for ln in message.splitlines()):
             if line:
@@ -218,7 +284,7 @@ def _run(
             print(f"==== {result.provider} Usage ====")
             print(f"provider: {result.provider}")
             print(f"model: {result.model}")
-            print(f"response_id: {getattr(result, 'response_id', '(n/a)')}")
+            print(f"response_id: {result.response_id or '(n/a)'}")
             if result.total_tokens is not None:
                 print(
                     f"tokens: prompt={result.prompt_tokens} completion={result.completion_tokens} total={result.total_tokens}"
@@ -240,7 +306,7 @@ def _run(
         print(f"==== {result.provider} Usage ====")
         print(f"provider: {result.provider}")
         print(f"model: {result.model}")
-        print(f"response_id: {getattr(result, 'response_id', '(n/a)')}")
+        print(f"response_id: {result.response_id or '(n/a)'}")
         if result.total_tokens is not None:
             print(
                 f"tokens: prompt={result.prompt_tokens} completion={result.completion_tokens} total={result.total_tokens}"
@@ -255,9 +321,9 @@ def _run(
         print(message)
 
     if args.edit:
-        rc: int = commit_with_message(message, True, repo_root)
+        rc: int = commit_with_message(message, True, repo_root, amend=args.amend)
     else:
-        rc = commit_with_message(message, False, repo_root)
+        rc = commit_with_message(message, False, repo_root, amend=args.amend)
 
     return rc
 
@@ -269,7 +335,8 @@ def main() -> None:
     """
 
     parser: Final[ArgumentParser] = _build_parser()
-    args: Namespace = parser.parse_args()
+    args = CliArgs()
+    parser.parse_args(namespace=args)
 
     if args.edit and not args.commit:
         print("'--edit' must be used together with '--commit'.", file=stderr)