git-copilot-commit 0.5.0__tar.gz → 0.5.2__tar.gz

{git_copilot_commit-0.5.0 → git_copilot_commit-0.5.2}/.justfile

@@ -38,7 +38,7 @@ bump type="patch":
     new_version=$(just next-version {{type}})
     echo "New version: $new_version"
 
-    git commit --allow-empty -m "Bump version to $new_version"
+    git commit --allow-empty -m "chore(build): Bump version to $new_version"
     git tag "$new_version"
 
     echo "✓ Created commit and tag for $new_version"

{git_copilot_commit-0.5.0 → git_copilot_commit-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-copilot-commit
-Version: 0.5.0
+Version: 0.5.2
 Summary: Automatically generate and commit changes using GitHub Copilot
 Author-email: Dheepak Krishnamurthy <1813121+kdheepak@users.noreply.github.com>
 License-File: LICENSE
@@ -14,6 +14,10 @@ Description-Content-Type: text/markdown
 
 # `git-copilot-commit`
 
+[![CI](https://img.shields.io/github/actions/workflow/status/kdheepak/git-copilot-commit/ci.yml?branch=main&label=CI)](https://github.com/kdheepak/git-copilot-commit/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/git-copilot-commit)](https://pypi.org/project/git-copilot-commit/)
+[![License](https://img.shields.io/github/license/kdheepak/git-copilot-commit)](https://github.com/kdheepak/git-copilot-commit/blob/main/LICENSE)
+
 AI-powered Git commit assistant that generates conventional commit messages using GitHub Copilot.
 
 ![Screenshot of git-copilot-commit in action](https://github.com/user-attachments/assets/6a6d70a6-6060-44e6-8cf4-a6532e9e9142)
@@ -21,13 +25,13 @@ AI-powered Git commit assistant that generates conventional commit messages usin
 ## Features
 
 - Generates commit messages based on your staged changes
-- Supports multiple AI models: GPT-4, Claude, Gemini, and more
+- Supports multiple LLM models: GPT-4, Claude, Gemini, and more
 - Allows editing of generated messages before committing
 - Follows the [Conventional Commits](https://www.conventionalcommits.org/) standard
 
 ## Installation
 
-### Install the tool using [`uv`] (recommended)
+### Install the tool using [`uv`]
 
 Install [`uv`]:
 
@@ -39,14 +43,15 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
 powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
 ```
 
-You can install and run the latest version of tool directly every time by invoking this one command:
+You can run the latest version of tool directly every time by invoking this one command:
 
 ```bash
-# Install latest version into temporary environment and run --help
+# Every invocation installs latest version into temporary environment and runs --help
 uvx git-copilot-commit --help
 ```
 
-Alternatively, you can install into a global isolated environment and run `git-copilot-commit`:
+Alternatively, you can install the tool once into a global isolated environment 
+and run `git-copilot-commit` to invoke it:
 
 ```bash
 # Install into global isolated environment
@@ -58,14 +63,6 @@ git-copilot-commit --help
 
 [`uv`]: https://github.com/astral-sh/uv
 
-### Install with `pipx`
-
-If you prefer to use `pipx`:
-
-```bash
-pipx install git-copilot-commit
-```
-
 ## Prerequisites
 
 - Active GitHub Copilot subscription
@@ -100,17 +97,26 @@ pipx install git-copilot-commit
 
 ```bash
 $ uvx git-copilot-commit commit --help
-Usage: git-copilot-commit commit [OPTIONS]
 
-  Automatically commit changes in the current git repository.
-
-Options:
-  -a, --all         Stage all files before committing
-  --split           Split staged hunks into multiple commits. Use
-                    `--split=N` to prefer up to N commits.
-  -m, --model TEXT  Model to use for generating commit message
-  -y, --yes         Automatically accept the generated commit message
-  --help            Show this message and exit.
+ Usage: git-copilot-commit commit [OPTIONS]
+
+ Generate commit message based on changes in the current git repository and commit them.
+
+╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --all         -a                               Stage all files before committing                         │
+│ --split                                        Split staged hunks into multiple commits automatically.   │
+│                                                Pass `--split=N` to express a preference for N commits.   │
+│ --model       -m                     MODEL_ID  Model to use for generating commit message                │
+│ --yes         -y                               Automatically accept the generated commit message         │
+│ --context     -c                     TEXT      Optional user-provided context to guide commit message    │
+│ --ca-bundle                          PATH      Path to a custom CA bundle (PEM)                          │
+│ --insecure                                     Disable SSL certificate verification.                     │
+│ --native-tls      --no-native-tls              Use the OS's native certificate store via 'truststore'    │
+│                                                for httpx instead of the Python bundle. Ignored if        │
+│                                                --ca-bundle or --insecure is used.                        │
+│                                                [default: no-native-tls]                                  │
+│ --help                                         Show this message and exit.                               │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ```
 
 ## Examples
@@ -139,7 +145,7 @@ Split staged hunks into separate commits:
 uvx git-copilot-commit commit --split
 ```
 
-Prefer up to two commits:
+Prefer two commits:
 
 ```bash
 uvx git-copilot-commit commit --split 2
@@ -194,3 +200,6 @@ git ai-commit --all --yes --model claude-3.5-sonnet
 > ```bash
 > git config --global diff.context 3
 > ```
+>
+> This may be useful because this tool sends the diffs with surrounding context 
+> to the LLM for generating a commit message

git_copilot_commit-0.5.2/README.md

@@ -0,0 +1,191 @@
+# `git-copilot-commit`
+
+[![CI](https://img.shields.io/github/actions/workflow/status/kdheepak/git-copilot-commit/ci.yml?branch=main&label=CI)](https://github.com/kdheepak/git-copilot-commit/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/git-copilot-commit)](https://pypi.org/project/git-copilot-commit/)
+[![License](https://img.shields.io/github/license/kdheepak/git-copilot-commit)](https://github.com/kdheepak/git-copilot-commit/blob/main/LICENSE)
+
+AI-powered Git commit assistant that generates conventional commit messages using GitHub Copilot.
+
+![Screenshot of git-copilot-commit in action](https://github.com/user-attachments/assets/6a6d70a6-6060-44e6-8cf4-a6532e9e9142)
+
+## Features
+
+- Generates commit messages based on your staged changes
+- Supports multiple LLM models: GPT-4, Claude, Gemini, and more
+- Allows editing of generated messages before committing
+- Follows the [Conventional Commits](https://www.conventionalcommits.org/) standard
+
+## Installation
+
+### Install the tool using [`uv`]
+
+Install [`uv`]:
+
+```bash
+# On macOS and Linux.
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# On Windows.
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
+```
+
+You can run the latest version of tool directly every time by invoking this one command:
+
+```bash
+# Every invocation installs latest version into temporary environment and runs --help
+uvx git-copilot-commit --help
+```
+
+Alternatively, you can install the tool once into a global isolated environment 
+and run `git-copilot-commit` to invoke it:
+
+```bash
+# Install into global isolated environment
+uv tool install git-copilot-commit
+
+# Run --help to see available commands
+git-copilot-commit --help
+```
+
+[`uv`]: https://github.com/astral-sh/uv
+
+## Prerequisites
+
+- Active GitHub Copilot subscription
+
+## Quick Start
+
+1. Authenticate with GitHub Copilot:
+
+   ```bash
+   uvx git-copilot-commit authenticate
+   ```
+
+   If your cached GitHub token is revoked or expires, refresh it with:
+
+   ```bash
+   uvx git-copilot-commit authenticate --force
+   ```
+
+2. Make changes in your repository.
+
+3. Generate and commit:
+
+   ```bash
+   uvx git-copilot-commit commit
+   # Or, if you want to stage all files and accept the generated commit message, use:
+   uvx git-copilot-commit commit --all --yes
+   ```
+
+## Usage
+
+### Commit changes
+
+```bash
+$ uvx git-copilot-commit commit --help
+
+ Usage: git-copilot-commit commit [OPTIONS]
+
+ Generate commit message based on changes in the current git repository and commit them.
+
+╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --all         -a                               Stage all files before committing                         │
+│ --split                                        Split staged hunks into multiple commits automatically.   │
+│                                                Pass `--split=N` to express a preference for N commits.   │
+│ --model       -m                     MODEL_ID  Model to use for generating commit message                │
+│ --yes         -y                               Automatically accept the generated commit message         │
+│ --context     -c                     TEXT      Optional user-provided context to guide commit message    │
+│ --ca-bundle                          PATH      Path to a custom CA bundle (PEM)                          │
+│ --insecure                                     Disable SSL certificate verification.                     │
+│ --native-tls      --no-native-tls              Use the OS's native certificate store via 'truststore'    │
+│                                                for httpx instead of the Python bundle. Ignored if        │
+│                                                --ca-bundle or --insecure is used.                        │
+│                                                [default: no-native-tls]                                  │
+│ --help                                         Show this message and exit.                               │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+## Examples
+
+Commit all changes:
+
+```bash
+uvx git-copilot-commit commit --all
+```
+
+Accept the generated commit message without editing:
+
+```bash
+uvx git-copilot-commit commit --yes
+```
+
+Use a specific model:
+
+```bash
+uvx git-copilot-commit commit --model claude-3.5-sonnet
+```
+
+Split staged hunks into separate commits:
+
+```bash
+uvx git-copilot-commit commit --split
+```
+
+Prefer two commits:
+
+```bash
+uvx git-copilot-commit commit --split 2
+```
+
+## Commit Message Format
+
+Follows [Conventional Commits](https://www.conventionalcommits.org/):
+
+```plaintext
+<type>[optional scope]: <description>
+```
+
+**Types:**
+
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation
+- `style`: Formatting only
+- `refactor`: Code restructure
+- `perf`: Performance
+- `test`: Tests
+- `chore`: Maintenance
+- `revert`: Revert changes
+
+## Git Configuration
+
+Add a git alias by adding the following to your `~/.gitconfig`:
+
+```ini
+[alias]
+    ai-commit = "!f() { uvx git-copilot-commit commit $@; }; f"
+```
+
+Now you can run to review the message before committing:
+
+```bash
+git ai-commit
+```
+
+Alternatively, you can stage all files and auto accept the commit message and
+specify which model should be used to generate the commit in one CLI invocation.
+
+```bash
+git ai-commit --all --yes --model claude-3.5-sonnet
+```
+
+> [!TIP]
+>
+> Show more context in diffs by running the following command:
+>
+> ```bash
+> git config --global diff.context 3
+> ```
+>
+> This may be useful because this tool sends the diffs with surrounding context 
+> to the LLM for generating a commit message

{git_copilot_commit-0.5.0 → git_copilot_commit-0.5.2}/src/git_copilot_commit/cli.py

@@ -19,11 +19,9 @@ from .git import GitRepository, GitError, GitStatus, NotAGitRepositoryError
 from .split_commits import (
     PatchUnit,
     SplitCommitPlan,
-    SplitCommitLimitExceededError,
     SplitPlanningError,
     build_split_plan_prompt,
     build_status_for_patch_units,
-    evaluate_auto_split,
     extract_patch_units,
     group_patch_units,
     parse_split_plan_response,
@@ -37,7 +35,6 @@ app = typer.Typer(help=__doc__, add_completion=False)
 
 COMMIT_MESSAGE_PROMPT_FILENAME = "commit-message-generator-prompt.md"
 SPLIT_COMMIT_PLANNER_PROMPT_FILENAME = "split-commit-planner-prompt.md"
-DEFAULT_AUTO_MAX_COMMITS = 10
 SPLIT_DIFF_ARGS = [
     "--binary",
     "--full-index",
@@ -75,7 +72,7 @@ SplitOption = Annotated[
         "--split",
         help=(
             "Split staged hunks into multiple commits automatically. Pass "
-            "`--split=N` to prefer up to N commits."
+            "`--split=N` to express a preference for N commits."
         ),
     ),
 ]
@@ -128,11 +125,7 @@ def preprocess_cli_args(args: Sequence[str]) -> list[str]:
             index += 1
             continue
 
-        if (
-            in_commit_command
-            and arg == "--split"
-            and index + 1 < len(args)
-        ):
+        if in_commit_command and arg == "--split" and index + 1 < len(args):
             split_value = args[index + 1].strip().lower()
             if split_value == "auto":
                 processed_args.append("--split")
@@ -352,21 +345,6 @@ def generate_commit_message_for_status(
     )
 
 
-def generate_commit_message(
-    repo: GitRepository,
-    model: str | None = None,
-    context: str = "",
-    http_client_config: github_copilot.HttpClientConfig | None = None,
-) -> str:
-    """Generate a conventional commit message using the repository's staged diff."""
-    return generate_commit_message_for_status(
-        repo.get_status(),
-        model=model,
-        context=context,
-        http_client_config=http_client_config,
-    )
-
-
 def commit_with_retry_no_verify(
     repo: GitRepository,
     message: str,
@@ -471,7 +449,6 @@ def request_split_commit_plan(
     status: GitStatus,
     patch_units: tuple[PatchUnit, ...],
     *,
-    max_commits: int,
     preferred_commits: int | None = None,
     model: str | None = None,
     context: str = "",
@@ -482,7 +459,6 @@ def request_split_commit_plan(
         planner_prompt = build_split_plan_prompt(
             status,
             patch_units,
-            max_commits=max_commits,
             preferred_commits=preferred_commits,
             context=context,
         )
@@ -499,7 +475,6 @@ def request_split_commit_plan(
         return parse_split_plan_response(
             response,
             patch_units,
-            max_commits=max_commits,
         )
     except github_copilot.CopilotError as exc:
         print_copilot_error("Could not generate a split commit plan", exc)
@@ -541,25 +516,31 @@ def request_split_commit_messages(
         raise typer.Exit(1)
 
 
-def resolve_split_commit_limit(
-    exc: SplitCommitLimitExceededError, *, yes: bool = False
+def confirm_split_commit_count(
+    plan: SplitCommitPlan,
+    *,
+    preferred_commits: int,
+    yes: bool = False,
 ) -> SplitCommitPlan:
-    """Ask whether to proceed when the planner exceeds the configured limit."""
+    """Ask whether to proceed when the planner exceeds the preferred count."""
+    actual_commits = len(plan.commits)
+    if actual_commits <= preferred_commits:
+        return plan
+
     console.print(
-        f"[yellow]Split planning produced {exc.actual_commits} commits, exceeding the automatic review limit of {exc.max_commits}.[/yellow]"
+        "[yellow]Split planning produced "
+        f"{actual_commits} commits, exceeding the preferred count of "
+        f"{preferred_commits}.[/yellow]"
     )
 
     if yes:
-        console.print(
-            "[red]Cannot ask whether to proceed because --yes was used. Re-run without --yes to review the larger plan.[/red]"
-        )
-        raise typer.Exit(1)
+        return plan
 
     if Confirm.ask(
-        f"Proceed with [bold]{exc.actual_commits} commits[/] anyway?",
+        f"Proceed with [bold]{actual_commits} commits[/] anyway?",
         default=False,
     ):
-        return exc.plan
+        return plan
 
     console.print("Split commit plan cancelled.")
     raise typer.Exit()
@@ -747,44 +728,24 @@ def handle_split_commit_flow(
         return
 
     if preferred_commits is None:
-        should_split, reason = evaluate_auto_split(patch_units)
-        if not should_split:
-            console.print(
-                "[yellow]Auto split not triggered: "
-                f"{reason}. Creating a single commit. Use [bold]--split N[/] to suggest an upper bound.[/yellow]"
-            )
-            handle_single_commit_flow(
-                repo,
-                status,
-                model=model,
-                yes=yes,
-                context=context,
-                http_client_config=http_client_config,
-            )
-            return
-
-        console.print(f"[yellow]Auto split triggered: {reason}.[/yellow]")
+        console.print(
+            "[yellow]Planning split commits from the staged patch units.[/yellow]"
+        )
     else:
         console.print(
-            f"[yellow]Planning up to {preferred_commits} commits from the staged patch units.[/yellow]"
+            "[yellow]Planning split commits with a preference for "
+            f"{preferred_commits} commits.[/yellow]"
         )
 
     try:
         split_plan = request_split_commit_plan(
             status,
             patch_units,
-            max_commits=(
-                DEFAULT_AUTO_MAX_COMMITS
-                if preferred_commits is None
-                else preferred_commits
-            ),
             preferred_commits=preferred_commits,
             model=model,
             context=context,
             http_client_config=http_client_config,
         )
-    except SplitCommitLimitExceededError as exc:
-        split_plan = resolve_split_commit_limit(exc, yes=yes)
     except SplitPlanningError as exc:
         console.print(
             "[yellow]Split planning returned an invalid plan; falling back to a single commit.[/yellow]"
@@ -800,6 +761,13 @@ def handle_split_commit_flow(
         )
         return
 
+    if preferred_commits is not None:
+        split_plan = confirm_split_commit_count(
+            split_plan,
+            preferred_commits=preferred_commits,
+            yes=yes,
+        )
+
     prepared_commits = request_split_commit_messages(
         split_plan,
         patch_units,

{git_copilot_commit-0.5.0 → git_copilot_commit-0.5.2}/src/git_copilot_commit/git.py

@@ -121,16 +121,31 @@ class GitRepository:
         Raises:
             NotAGitRepositoryError: If the path is not a git repository.
         """
-        self.repo_path = repo_path or Path.cwd()
+        self.cwd = (repo_path or Path.cwd()).resolve()
         self.timeout = timeout
-        self._validate_git_repo()
+        self.repo_path = self._resolve_repo_root()
 
-    def _validate_git_repo(self) -> None:
-        """Ensure we're in a git repository."""
+    def _resolve_repo_root(self) -> Path:
+        """Resolve and cache the repository top-level path."""
         try:
-            self._run_git_command(["rev-parse", "--git-dir"])
-        except GitCommandError:
-            raise NotAGitRepositoryError(f"{self.repo_path} is not a git repository")
+            result = subprocess.run(
+                ["git", "rev-parse", "--show-toplevel"],
+                cwd=self.cwd,
+                capture_output=True,
+                text=True,
+                timeout=self.timeout,
+                check=True,
+            )
+        except subprocess.CalledProcessError:
+            raise NotAGitRepositoryError(f"{self.cwd} is not a git repository")
+        except subprocess.TimeoutExpired:
+            raise GitCommandError("Git command timed out: git rev-parse --show-toplevel")
+
+        repo_root = result.stdout.strip()
+        if not repo_root:
+            raise NotAGitRepositoryError(f"{self.cwd} is not a git repository")
+
+        return Path(repo_root)
 
     def _run_git_command(
         self,
@@ -188,6 +203,21 @@ class GitRepository:
         merged_env.update(env)
         return merged_env
 
+    def _normalize_paths(self, paths: list[str]) -> list[str]:
+        """Normalize user paths relative to the repository root."""
+        normalized_paths: list[str] = []
+        for path in paths:
+            path_obj = Path(path)
+            if path_obj.is_absolute():
+                normalized_paths.append(str(path_obj))
+                continue
+
+            normalized_paths.append(
+                os.path.relpath(self.cwd / path_obj, start=self.repo_path)
+            )
+
+        return normalized_paths
+
     def get_status(self, env: Mapping[str, str] | None = None) -> GitStatus:
         """
         Get comprehensive git status information.
@@ -263,16 +293,16 @@ class GitRepository:
         Stage files for commit.
 
         Args:
-          paths: List of file paths to stage. If None, stages all files (git add .).
+          paths: List of file paths to stage. If None, stages all files.
         """
         if paths is None:
-            self._run_git_command(["add", "."])
+            self._run_git_command(["add", "--all"])
         else:
-            self._run_git_command(["add"] + paths)
+            self._run_git_command(["add"] + self._normalize_paths(paths))
 
     def stage_modified(self) -> None:
-        """Stage all modified files (git add -u)."""
-        self._run_git_command(["add", "-u"])
+        """Stage all modified tracked files."""
+        self._run_git_command(["add", "--update"])
 
     def unstage_files(self, paths: list[str] | None = None) -> None:
         """
@@ -284,7 +314,7 @@ class GitRepository:
         if paths is None:
             self._run_git_command(["reset", "HEAD"])
         else:
-            self._run_git_command(["reset", "HEAD"] + paths)
+            self._run_git_command(["reset", "HEAD"] + self._normalize_paths(paths))
 
     def create_alternate_index(self, from_ref: str = "HEAD") -> AlternateGitIndex:
         """Create a temporary git index initialized from the provided ref."""