git-commit-message 0.6.0__tar.gz → 0.8.0__tar.gz

{git_commit_message-0.6.0 → git_commit_message-0.8.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: git-commit-message
-Version: 0.6.0
-Summary: Generate Git commit messages from staged changes using OpenAI GPT
+Version: 0.8.0
+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.
         
@@ -44,16 +44,23 @@ Classifier: Topic :: Software Development :: Version Control :: Git
 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 ...`)
+
+## Install
 
 Install the latest released version from PyPI:
 
@@ -77,13 +84,43 @@ Quick check:
 git-commit-message --help
 ```
 
-Set your API key (POSIX sh):
+## Setup
+
+### OpenAI
 
 ```sh
 export OPENAI_API_KEY="sk-..."
 ```
 
-Note (fish): In fish, set it as follows.
+### 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-..."
@@ -97,71 +134,116 @@ 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"
 ```
 
-- Limit subject length (default 72):
+Select provider:
 
 ```sh
-git-commit-message --one-line --max-length 50 "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
 ```
 
-- Chunk long diffs by token budget (0 = single chunk + summary, -1 = disable chunking):
+Commit immediately (optionally open editor):
+
+```sh
+git-commit-message --commit "refactor parser for speed"
+git-commit-message --commit --edit "refactor parser for speed"
+```
+
+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 "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
 ```
 
-- Select output language/locale (default: en-GB):
+Print debug info:
 
 ```sh
-# American English
-git-commit-message --language en-US "optional context"
+git-commit-message --debug
+```
 
-# Korean
-git-commit-message --language ko-KR
+Configure Ollama host (if running on a different machine):
 
-# Japanese
-git-commit-message --language ja-JP
+```sh
+git-commit-message --provider ollama --host http://192.168.1.100:11434
 ```
 
-Notes:
+## 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>`
+- `--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:
 
-- 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.
+- `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`)
 
-Environment:
+Default models (if not overridden):
 
-- `OPENAI_API_KEY`: required
-- `GIT_COMMIT_MESSAGE_MODEL` or `OPENAI_MODEL`: optional (default: `gpt-5-mini`)
-- `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)
+- 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.0/README.md

@@ -0,0 +1,198 @@
+# 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 ...`)
+
+## 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"
+```
+
+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>`
+- `--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.6.0 → git_commit_message-0.8.0}/pyproject.toml

@@ -1,11 +1,13 @@
 [project]
 name = "git-commit-message"
-version = "0.6.0"
-description = "Generate Git commit messages from staged changes using OpenAI GPT"
+version = "0.8.0"
+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.6.0 → git_commit_message-0.8.0}/src/git_commit_message/_cli.py

@@ -1,6 +1,6 @@
 """Command-line interface entry point.
 
-Collect staged changes from the repository and call an OpenAI GPT model
+Collect staged changes from the repository and call an LLM provider
 to generate a commit message, or create a commit straight away.
 """
 
@@ -19,13 +19,46 @@ from ._git import (
     get_staged_diff,
     has_staged_changes,
 )
-from ._gpt import (
+from ._llm import (
+    CommitMessageResult,
+    UnsupportedProviderError,
     generate_commit_message,
     generate_commit_message_with_info,
-    CommitMessageResult,
 )
 
 
+class CliArgs(Namespace):
+    __slots__ = (
+        "description",
+        "commit",
+        "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.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."""
 
@@ -50,7 +83,7 @@ def _build_parser() -> ArgumentParser:
     parser: ArgumentParser = ArgumentParser(
         prog="git-commit-message",
         description=(
-            "Generate a commit message with OpenAI GPT based on the staged changes."
+            "Generate a commit message based on the staged changes."
         ),
     )
 
@@ -72,11 +105,21 @@ def _build_parser() -> ArgumentParser:
         help="Open an editor to amend the message before committing. Use with '--commit'.",
     )
 
+    parser.add_argument(
+        "--provider",
+        default=None,
+        help=(
+            "LLM provider to use (default: openai). "
+            "You may also set GIT_COMMIT_MESSAGE_PROVIDER. "
+            "The CLI flag overrides the environment variable."
+        ),
+    )
+
     parser.add_argument(
         "--model",
         default=None,
         help=(
-            "OpenAI model name to use. If unspecified, uses the environment variables (GIT_COMMIT_MESSAGE_MODEL, OPENAI_MODEL) or 'gpt-5-mini'."
+            "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)."
         ),
     )
 
@@ -123,11 +166,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.
@@ -166,10 +219,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,
+                args.provider,
+                args.host,
             )
             message = result.message
         else:
@@ -177,17 +232,22 @@ 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,
+                args.provider,
+                args.host,
             )
+    except UnsupportedProviderError as exc:
+        print(str(exc), file=stderr)
+        return 3
     except Exception as exc:  # noqa: BLE001 - to preserve standard output messaging
         print(f"Failed to generate commit message: {exc}", file=stderr)
         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:
@@ -199,9 +259,10 @@ def _run(
     if not args.commit:
         if args.debug and result is not None:
             # Print debug information
-            print("==== OpenAI Usage ====")
+            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}"
@@ -220,9 +281,10 @@ def _run(
 
     if args.debug and result is not None:
         # Also print debug info before commit
-        print("==== OpenAI Usage ====")
+        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}"
@@ -251,7 +313,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)