git-cai-cli 0.1.1.dev0__tar.gz → 0.2.0__tar.gz

{git_cai_cli-0.1.1.dev0 → git_cai_cli-0.2.0}/.linters/.pylintrc

@@ -91,7 +91,8 @@ logging-modules=logging                    # Logging library to check against
 confidence=HIGH,CONTROL_FLOW,INFERENCE,INFERENCE_FAILURE,UNDEFINED
                                            # Only show warnings with these confidence levels
 disable=logging-too-many-args,
-        import-error
+        import-error,
+        wrong-import-order
                                            # Disable noisy/meta warnings
 
 

{git_cai_cli-0.1.1.dev0 → git_cai_cli-0.2.0}/Makefile

@@ -4,7 +4,7 @@ PIP := pipx
 UV := uv
 SHELL := /bin/bash
 
-.PHONY: help lint check-docker check-npx lint-fix add-lint-hook clean
+.PHONY: help lint check-docker check-npx lint-fix add-lint-hook clean test
 
 help: ## Shows this help message
 	@echo "Available commands:"
@@ -14,7 +14,9 @@ add-lint-hook: ## Adds a git pre-push hook to automatically run 'lint' before pu
 	@echo "#!/bin/bash" > .git/hooks/pre-push
 	@echo "make lint" >> .git/hooks/pre-push
 	@chmod +x .git/hooks/pre-push
+	@echo "make test" >> .git/hooks/pre-push
 	@echo "Pre-push hook added. The 'lint' command will now run before each push."
+	@echo "Pre-push hook added. The 'test' command will now run before each push."	
 
 check-docker: ## Checks if docker is installed
 	@if ! command -v docker &> /dev/null; then \
@@ -38,10 +40,12 @@ clean: ## Clean cache of uv and delete virtual environment
 	@$(UV) cache clean
 	@rm -rf .venv
 
-
 lint:
 	@sh ./.linters/check_git_branch_name.sh
 	@npx mega-linter-runner	--flavor python
 
 lint-fix: ## Lints the code using sqlfluff and fixes the issues
 	@npx mega-linter-runner --fix
+
+test: ## Runs tests
+	@$(UV) run pytest

git_cai_cli-0.2.0/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: git-cai-cli
+Version: 0.2.0
+Summary: Use LLM to create git commit messages
+Author-email: Thorsten Foltz <thorsten.foltz@live.com>
+License: MIT
+Project-URL: Homepage, https://github.com/thorstenfoltz/cai
+Project-URL: Issues, https://github.com/thorstenfoltz/cai/issues
+Keywords: Git,LLM,Commit,AI,GenAI
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+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
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Version Control
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: openai>=1.0
+Requires-Dist: google-genai>=1.39
+Requires-Dist: typer>=0.19.2
+Requires-Dist: requests>=2.32.5
+Dynamic: license-file
+
+# cai
+
+cai is a Git extension written in Python that automates the creation of commit messages. With it, you can simply run `git cai` to automatically generate a commit message based on the changes and new files in your repository.
+
+cai uses a large language model (LLM) to produce commit messages that are meaningful and context-aware. It currently supports both the OpenAI API and the Gemini API for message generation.
+
+## Table of Contents
+
+- [About](#about-section)
+- [Prerequisites](#prerequisites)
+- [Features](#features-section)
+- [Installation](#installation-section)
+- [Usage](#usage-section)
+- [Configuration](#config-section)
+- [CLI](#cli)
+- [License](#license-section)
+
+<h2 id="about-section">About</h2>
+
+cai is designed to simplify your Git workflow by automatically generating commit messages using an LLM. No more struggling to summarize changes, just run git cai, and it handles it for you.
+
+Currently, the only supported backends are the OpenAI and Gemini APIs, but additional LLM integrations may be added in the future.
+
+<h2 id="prerequisites">Prerequisites</h2>
+
+- Python 3.10 or higher
+- [Pipx](https://pypi.org/project/pipx/) or [Pip](https://pypi.org/project/pip/) if installed in a virtual environment
+- API key, currently supported
+  - OpenAI
+  - Gemini
+
+<h2 id="features-section">Features</h2>
+
+- Automatically detects added, modified, and deleted files
+- Generates meaningful, context-aware commit messages using an LLM
+- Seamless integration with Git as a plugin/extension
+- Supports different LLM models and languages for each repository, as well as global configuration
+
+<h2 id="installation-section">Installation</h2>
+
+You can install cai using pipx:
+
+```sh
+pipx install git-cai-cli
+```
+
+After installation, make sure cai is added to your `PATH`:
+
+```sh
+pipx ensurepath
+```
+
+Then, restart your shell (e.g., bash, zsh, or whichever shell you use) for the changes to take effect.
+
+<h2 id="usage-section">Usage</h2>
+
+Once installed, cai works like a standard Git command:
+
+```sh
+git cai
+```
+
+`cai` uses Git’s `diff` output as input for generating commit messages.  
+To exclude specific files or directories from being included in the generated commit message, create a `.caiignore` file in the root of your repository. This file works like a `.gitignore`.  
+
+- Files listed in `.gitignore` are **always excluded**.  
+- `.caiignore` is only needed for files that are tracked by Git but should **not** be included in the commit message.
+
+<h2 id="config-section">Configuration</h2>
+
+The first time you run `git cai`, it automatically creates two configuration files:
+
+- `cai_config.yml` – Stores general settings:
+
+```sh
+home/<USERNAME>/.config/cai/cai_config.yml
+```
+
+- `tokens.yml` – Stores your API token(s):
+
+```sh
+home/<USERNAME>/.config/cai/tokens.yml
+```
+
+Add your OpenAI and/or Gemini API token to `tokens.yml` so that cai can use it each time you generate a commit message.
+
+If a `cai_config.yml` file exists in the root of your repository, cai will use the settings defined there. Otherwise, it falls back to the default settings.
+
+To use a repository-specific configuration, copy the config file to the root of your repository and adjust it as needed:
+
+```sh
+cp ~/.config/cai/cai_config.yml .
+```
+
+Currently, the following options can be customized:
+
+- default: set the default provider
+- model: specify which model of the provider to use
+- temperature: control how creative the model’s responses are
+- language: set the language in which the LLM should generate commit messages
+
+<h2 id="cli">CLI</h2>
+
+Besides running `git cai` to generate commit messages, you can use the following options:
+
+- `-h` shows a brief help message with available commands
+- `d`, `--debug` enables debug logging to help troubleshoot issues
+- `l`, `--languages` list available languages
+- `u`, `--update` checks for updates the `cai` tool
+- `v`, `--version` displays the currently installed version
+
+<h2 id="license-section">License</h2>
+This project is licensed under the MIT License.

git_cai_cli-0.2.0/README.md

@@ -0,0 +1,113 @@
+# cai
+
+cai is a Git extension written in Python that automates the creation of commit messages. With it, you can simply run `git cai` to automatically generate a commit message based on the changes and new files in your repository.
+
+cai uses a large language model (LLM) to produce commit messages that are meaningful and context-aware. It currently supports both the OpenAI API and the Gemini API for message generation.
+
+## Table of Contents
+
+- [About](#about-section)
+- [Prerequisites](#prerequisites)
+- [Features](#features-section)
+- [Installation](#installation-section)
+- [Usage](#usage-section)
+- [Configuration](#config-section)
+- [CLI](#cli)
+- [License](#license-section)
+
+<h2 id="about-section">About</h2>
+
+cai is designed to simplify your Git workflow by automatically generating commit messages using an LLM. No more struggling to summarize changes, just run git cai, and it handles it for you.
+
+Currently, the only supported backends are the OpenAI and Gemini APIs, but additional LLM integrations may be added in the future.
+
+<h2 id="prerequisites">Prerequisites</h2>
+
+- Python 3.10 or higher
+- [Pipx](https://pypi.org/project/pipx/) or [Pip](https://pypi.org/project/pip/) if installed in a virtual environment
+- API key, currently supported
+  - OpenAI
+  - Gemini
+
+<h2 id="features-section">Features</h2>
+
+- Automatically detects added, modified, and deleted files
+- Generates meaningful, context-aware commit messages using an LLM
+- Seamless integration with Git as a plugin/extension
+- Supports different LLM models and languages for each repository, as well as global configuration
+
+<h2 id="installation-section">Installation</h2>
+
+You can install cai using pipx:
+
+```sh
+pipx install git-cai-cli
+```
+
+After installation, make sure cai is added to your `PATH`:
+
+```sh
+pipx ensurepath
+```
+
+Then, restart your shell (e.g., bash, zsh, or whichever shell you use) for the changes to take effect.
+
+<h2 id="usage-section">Usage</h2>
+
+Once installed, cai works like a standard Git command:
+
+```sh
+git cai
+```
+
+`cai` uses Git’s `diff` output as input for generating commit messages.  
+To exclude specific files or directories from being included in the generated commit message, create a `.caiignore` file in the root of your repository. This file works like a `.gitignore`.  
+
+- Files listed in `.gitignore` are **always excluded**.  
+- `.caiignore` is only needed for files that are tracked by Git but should **not** be included in the commit message.
+
+<h2 id="config-section">Configuration</h2>
+
+The first time you run `git cai`, it automatically creates two configuration files:
+
+- `cai_config.yml` – Stores general settings:
+
+```sh
+home/<USERNAME>/.config/cai/cai_config.yml
+```
+
+- `tokens.yml` – Stores your API token(s):
+
+```sh
+home/<USERNAME>/.config/cai/tokens.yml
+```
+
+Add your OpenAI and/or Gemini API token to `tokens.yml` so that cai can use it each time you generate a commit message.
+
+If a `cai_config.yml` file exists in the root of your repository, cai will use the settings defined there. Otherwise, it falls back to the default settings.
+
+To use a repository-specific configuration, copy the config file to the root of your repository and adjust it as needed:
+
+```sh
+cp ~/.config/cai/cai_config.yml .
+```
+
+Currently, the following options can be customized:
+
+- default: set the default provider
+- model: specify which model of the provider to use
+- temperature: control how creative the model’s responses are
+- language: set the language in which the LLM should generate commit messages
+
+<h2 id="cli">CLI</h2>
+
+Besides running `git cai` to generate commit messages, you can use the following options:
+
+- `-h` shows a brief help message with available commands
+- `d`, `--debug` enables debug logging to help troubleshoot issues
+- `l`, `--languages` list available languages
+- `u`, `--update` checks for updates the `cai` tool
+- `v`, `--version` displays the currently installed version
+
+<h2 id="license-section">License</h2>
+This project is licensed under the MIT License.

git_cai_cli-0.2.0/archlinux/PKGBUILD

@@ -0,0 +1,23 @@
+# Maintainer: Thorsten Foltz <thorsten.foltz@live.com>
+pkgname=git-cai-cli
+pkgver=0.1.1
+pkgrel=1
+pkgdesc="Use LLM to create git commit messages."
+arch=('any')
+url="https://github.com/thorstenfoltz/cai"
+license=('MIT')
+depends=('python' 'python-yaml' 'python-openai' 'python-google-genai')
+makedepends=(python-build python-installer python-setuptools python-wheel)
+source=("https://files.pythonhosted.org/packages/e6/c3/99bb2d87c16628017468c9ae6dd18ee2e63644109150bee0450a9f22b83f/git_cai_cli-0.1.1.tar.gz")
+sha256sums=('36fb55223ad430b7d3dc6bf60fd4e04f6ac567acee5546d5aa8c2df781061461')
+
+build() {
+    cd "${srcdir}/git_cai_cli-${pkgver}"
+    python -m build --wheel --no-isolation
+}
+
+package() {
+    cd "${srcdir}/git_cai_cli-${pkgver}"
+    python -m installer --destdir="$pkgdir" dist/*.whl
+}
+ 

{git_cai_cli-0.1.1.dev0 → git_cai_cli-0.2.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "git-cai-cli"
 dynamic = ["version"]
-description = "Use LLM to create git commits"
+description = "Use LLM to create git commit messages"
 authors = [{ name = "Thorsten Foltz", email = "thorsten.foltz@live.com" }]
 keywords = ["Git", "LLM", "Commit", "AI", "GenAI"]
 readme = "README.md"
@@ -9,11 +9,13 @@ requires-python = ">=3.10"
 dependencies = [
     "pyyaml>=6.0",
     "openai>=1.0",
-    "google-genai>=1.41.0",
+    "google-genai>=1.39",
+    "typer>=0.19.2",
+    "requests>=2.32.5",
 ]
 license = { text = "MIT" }
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "Environment :: Console",
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3",
@@ -30,7 +32,7 @@ Homepage = "https://github.com/thorstenfoltz/cai"
 Issues = "https://github.com/thorstenfoltz/cai/issues"
 
 [project.scripts]
-git-cai = "git_cai_cli.cli:main"
+git-cai = "git_cai_cli.cli:app"
 
 [build-system]
 requires = ["setuptools>=64", "setuptools-scm>=8"]
@@ -47,4 +49,5 @@ local_scheme = "no-local-version"
 dev = [
     "build>=1.3.0",
     "pytest>=8.4.2",
+    "twine>=6.2.0",
 ]

git_cai_cli-0.2.0/src/git_cai_cli/cli.py

@@ -0,0 +1,111 @@
+"""
+Main function
+"""
+
+import logging
+import subprocess
+import sys
+from pathlib import Path
+
+import typer
+from git_cai_cli.core.config import get_default_config, load_config, load_token
+from git_cai_cli.core.gitutils import find_git_root, git_diff_excluding
+from git_cai_cli.core.llm import CommitMessageGenerator
+from git_cai_cli.core.options import CliManager
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="%(asctime)s.%(msecs)03d [%(levelname)s] %(message)s",
+    datefmt="%Y-%m-%d %H:%M:%S",
+)
+log = logging.getLogger(__name__)
+
+app = typer.Typer(add_completion=True, help=None, no_args_is_help=False)
+
+manager = CliManager(package_name="git-cai-cli")
+
+
+def main() -> None:
+    """
+    Check for git repo, load access tokens and run git cai
+    """
+    # Ensure invoked as 'git cai'
+    # Only enforce this if we're not just asking for version/help
+    if not any(flag in sys.argv for flag in ("--version", "-v", "--help", "-h")):
+        invoked_as = Path(sys.argv[0]).name
+        if not invoked_as.startswith("git-"):
+            print("This command must be run as 'git cai'", file=sys.stderr)
+            sys.exit(1)
+
+    # Find the git repo root
+    repo_root = find_git_root()
+    if not repo_root:
+        log.error("Not inside a Git repository.")
+        sys.exit(1)
+
+    # Load configuration and token
+    config = load_config()
+    default_model = get_default_config()
+    log.debug("Default model from config: %s", default_model)
+    token = load_token(default_model)
+    if not token:
+        log.error("Missing %s token in ~/.config/cai/tokens.yml", default_model)
+        sys.exit(1)
+
+    # Get git diff
+    diff = git_diff_excluding(repo_root)
+    if not diff.strip():
+        log.info("No changes to commit. Did you run 'git add'? Files must be staged.")
+        sys.exit(0)
+
+    # Generate commit message
+    generator = CommitMessageGenerator(token, config, default_model)
+    commit_message = generator.generate(diff)
+
+    # Open git commit editor with the generated message
+    subprocess.run(["git", "commit", "--edit", "-m", commit_message], check=True)
+
+
+@app.command()
+def run(
+    help_flag: bool = typer.Option(False, "-h", help="Show help", is_eager=True),
+    enable_debug: bool = typer.Option(
+        False, "--debug", "-d", help="Enable debug logging", is_eager=True
+    ),
+    language: bool = typer.Option(
+        False, "--languages", "-l", help="List supported languages", is_eager=True
+    ),
+    update: bool = typer.Option(
+        False, "--update", "-u", help="Check for updates", is_eager=True
+    ),
+    version: bool = typer.Option(
+        False, "--version", "-v", help="Show version", is_eager=True
+    ),
+):
+    """
+    Main entry point for the CLI
+    """
+    if help_flag:
+        typer.echo(manager.get_help())
+        raise typer.Exit()
+
+    if enable_debug:
+        typer.echo(manager.enable_debug())
+
+    if language:
+        typer.echo(manager.print_available_languages())
+        raise typer.Exit()
+
+    if update:
+        typer.echo(manager.check_and_update())
+        raise typer.Exit()
+
+    if version:
+        typer.echo(manager.get_version())
+        raise typer.Exit()
+
+    main()
+
+
+if __name__ == "__main__":
+    app()

{git_cai_cli-0.1.1.dev0 → git_cai_cli-0.2.0}/src/git_cai_cli/core/config.py

@@ -10,6 +10,7 @@ from typing import Any, Optional
 
 import yaml
 from git_cai_cli.core.gitutils import find_git_root
+from git_cai_cli.core.languages import ALLOWED_LANGUAGES
 
 log = logging.getLogger(__name__)
 
@@ -20,6 +21,7 @@ TOKENS_FILE = CONFIG_DIR / "tokens.yml"
 DEFAULT_CONFIG = {
     "openai": {"model": "gpt-4.1", "temperature": 0},
     "gemini": {"model": "gemini-2.5-flash", "temperature": 0},
+    "language": "en",
     "default": "openai",
 }
 
@@ -32,14 +34,20 @@ TOKEN_TEMPLATE = {
 def load_config(
     fallback_config_file: Path = FALLBACK_CONFIG_FILE,
     default_config: Optional[dict[str, Any]] = None,
+    allowed_languages: Optional[set[str]] = None,
 ) -> dict[str, Any]:
     """
-    Load configuration of LLM
+    Load configuration of LLM and validate structure and language.
     """
     if default_config is None:
         default_config = DEFAULT_CONFIG.copy()
     log.debug("Loading config...")
 
+    languages: set[str] = (
+        ALLOWED_LANGUAGES.copy() if allowed_languages is None else allowed_languages
+    )
+    log.debug("Loading allowed languages...")
+
     repo_root = find_git_root()
     repo_config_file = Path(repo_root) / "cai_config.yml" if repo_root else None
 
@@ -48,6 +56,8 @@ def load_config(
             with open(repo_config_file, "r", encoding="utf-8") as f:
                 config = yaml.safe_load(f) or {}
             if config:
+                _validate_config_keys(config, DEFAULT_CONFIG)
+                config["language"] = _validate_language(config, languages)
                 return config
         except yaml.YAMLError as e:
             log.error("Failed to parse repo config: %s", e)
@@ -60,13 +70,18 @@ def load_config(
         fallback_config_file.parent.mkdir(parents=True, exist_ok=True)
         with open(fallback_config_file, "w", encoding="utf-8") as f:
             yaml.safe_dump(default_config, f)
+        default_config["language"] = _validate_language(default_config, languages)
         return default_config
 
     try:
         with open(fallback_config_file, "r", encoding="utf-8") as f:
-            return yaml.safe_load(f) or default_config
+            config = yaml.safe_load(f) or default_config
+        _validate_config_keys(config, DEFAULT_CONFIG)
+        config["language"] = _validate_language(config, languages)
+        return config
     except yaml.YAMLError as e:
         log.error("Failed to parse config at %s: %s", fallback_config_file, e)
+        default_config["language"] = _validate_language(default_config, languages)
         return default_config
 
 
@@ -144,3 +159,30 @@ def get_default_config() -> str:
     default_value = config["default"]
     log.info("Default config value: %s", default_value)
     return default_value
+
+
+def _validate_config_keys(config: dict[str, Any], reference: dict[str, Any]) -> None:
+    """
+    Check for missing or extra keys in config.
+    """
+    missing_keys = set(reference.keys()) - set(config.keys())
+    extra_keys = set(config.keys()) - set(reference.keys())
+
+    if missing_keys:
+        log.warning("Config is missing keys: %s", ", ".join(missing_keys))
+    if extra_keys:
+        log.error("Config includes unknown keys: %s", ", ".join(extra_keys))
+
+
+def _validate_language(config: dict[str, Any], allowed_languages: set[str]) -> str:
+    """
+    Validate that the language code exists in the allowed set.
+    Returns the ISO 639-1 code.
+    """
+    lang_code = config.get("language")
+    if not lang_code or lang_code not in allowed_languages:
+        log.warning(
+            "Language code '%s' is not supported. Falling back to 'en'.", lang_code
+        )
+        return "en"
+    return lang_code

git_cai_cli-0.2.0/src/git_cai_cli/core/languages.py

@@ -0,0 +1,100 @@
+"""
+Set the language for the AI responses.
+"""
+
+LANGUAGE_MAP = {
+    "af": "Afrikaans",
+    "am": "Amharic",
+    "ar": "Arabic",
+    "az": "Azerbaijani",
+    "be": "Belarusian",
+    "bg": "Bulgarian",
+    "bn": "Bengali",
+    "bo": "Tibetan",
+    "bs": "Bosnian",
+    "ca": "Catalan",
+    "ce": "Chechen",
+    "cs": "Czech",
+    "cy": "Welsh",
+    "da": "Danish",
+    "de": "German",
+    "dot": "Dothraki",
+    "el": "Greek",
+    "en": "English",
+    "eo": "Esperanto",
+    "es": "Spanish",
+    "et": "Estonian",
+    "eu": "Basque",
+    "fa": "Persian",
+    "fi": "Finnish",
+    "fo": "Faroese",
+    "fr": "French",
+    "ga": "Irish",
+    "gl": "Galician",
+    "gu": "Gujarati",
+    "ha": "Hausa",
+    "he": "Hebrew",
+    "hi": "Hindi",
+    "hr": "Croatian",
+    "hu": "Hungarian",
+    "hy": "Armenian",
+    "id": "Indonesian",
+    "is": "Icelandic",
+    "it": "Italian",
+    "ja": "Japanese",
+    "jv": "Javanese",
+    "ka": "Georgian",
+    "kk": "Kazakh",
+    "kl": "Kalaallisut",
+    "km": "Khmer",
+    "kn": "Kannada",
+    "ko": "Korean",
+    "ku": "Kurdish",
+    "la": "Latin",
+    "lb": "Luxembourgish",
+    "lt": "Lithuanian",
+    "lv": "Latvian",
+    "mk": "Macedonian",
+    "ml": "Malayalam",
+    "mn": "Mongolian",
+    "ms": "Malay",
+    "mr": "Marathi",
+    "mt": "Maltese",
+    "my": "Burmese",
+    "ne": "Nepali",
+    "nl": "Dutch",
+    "no": "Norwegian",
+    "or": "Odia",
+    "pa": "Punjabi",
+    "pl": "Polish",
+    "ps": "Pashto",
+    "pt": "Portuguese",
+    "ro": "Romanian",
+    "ru": "Russian",
+    "sd": "Sindhi",
+    "si": "Sinhala",
+    "sk": "Slovak",
+    "sl": "Slovenian",
+    "so": "Somali",
+    "sq": "Albanian",
+    "sr": "Serbian",
+    "su": "Sundanese",
+    "sv": "Swedish",
+    "sw": "Swahili",
+    "ta": "Tamil",
+    "te": "Telugu",
+    "tg": "Tajik",
+    "th": "Thai",
+    "tlh": "Klingon",
+    "tl": "Tagalog",
+    "tr": "Turkish",
+    "ug": "Uyghur",
+    "uk": "Ukrainian",
+    "ur": "Urdu",
+    "uz": "Uzbek",
+    "val": "Valyrian",
+    "vi": "Vietnamese",
+    "zh": "Chinese",
+}
+
+ALLOWED_LANGUAGES = set(LANGUAGE_MAP.keys())