git-copilot-commit 0.1.8__tar.gz → 0.1.10__tar.gz

{git_copilot_commit-0.1.8 → git_copilot_commit-0.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-copilot-commit
-Version: 0.1.8
+Version: 0.1.10
 Summary: Automatically generate and commit changes using copilot
 Author-email: Dheepak Krishnamurthy <1813121+kdheepak@users.noreply.github.com>
 License-File: LICENSE
@@ -15,6 +15,8 @@ Description-Content-Type: text/markdown
 
 AI-powered Git commit assistant that generates conventional commit messages using GitHub Copilot.
 
+![](https://github.com/user-attachments/assets/6a6d70a6-6060-44e6-8cf4-a6532e9e9142)
+
 ## Features
 
 - Generates commit messages based on your staged changes
@@ -69,39 +71,54 @@ git-copilot-commit commit
 ### Commit changes
 
 ```bash
-git-copilot-commit commit
-```
-
-**Options:**
-
-- `--all, -a`: Stage all files
-- `--verbose, -v`: Show detailed output
-- `--model, -m`: Choose an AI model
+$ uvx git-copilot-commit commit --help
+Usage: git-copilot-commit commit [OPTIONS]
 
-Workflow:
+  Automatically commit changes in the current git repository.
 
-1. Analyze changes
-2. Prompt to stage files
-3. Generate a commit message
-4. Choose to commit, edit, or cancel
+Options:
+  -a, --all         Stage all files before committing
+  -v, --verbose     Show verbose output
+  -m, --model TEXT  Model to use for generating commit message
+  --help            Show this message and exit.
+```
 
 ### Authenticate
 
 ```bash
-git-copilot-commit authenticate
+$ uvx git-copilot-commit authenticate --help
+Usage: git-copilot-commit authenticate [OPTIONS]
+
+  Autheticate with GitHub Copilot.
+
+Options:
+  --help  Show this message and exit.
 ```
 
 ### List models
 
 ```bash
-git-copilot-commit models
+$ uvx git-copilot-commit models --help
+Usage: git-copilot-commit models [OPTIONS]
+
+  List models available for chat in a table.
+
+Options:
+  --help  Show this message and exit.
 ```
 
 ### Configure
 
 ```bash
-git-copilot-commit config --show
-git-copilot-commit config --set-default-model gpt-4o
+$ uvx git-copilot-commit config --help
+Usage: git-copilot-commit config [OPTIONS]
+
+  Manage application configuration.
+
+Options:
+  --set-default-model TEXT  Set default model for commit messages
+  --show                    Show current configuration
+  --help                    Show this message and exit.
 ```
 
 ## Examples
@@ -152,13 +169,6 @@ Follows [Conventional Commits](https://www.conventionalcommits.org/):
 - `chore`: Maintenance
 - `revert`: Revert changes
 
-**Examples:**
-
-- `feat(auth): add JWT authentication`
-- `fix(db): retry connection on failure`
-- `docs(readme): update install steps`
-- `refactor(utils): simplify date parsing`
-
 ## Git Configuration
 
 Add a git alias by adding the following to your `~/.gitconfig`:
@@ -172,11 +182,11 @@ Now you can run:
 
 ```bash
 git ai-commit
-git ai-commit --model claude-3.5-sonnet
 git ai-commit --all --verbose
+git ai-commit --model claude-3.5-sonnet
 ```
 
-Show more context in diffs:
+Additionally, show more context in diffs by running the following command:
 
 ```bash
 git config --global diff.context 3

{git_copilot_commit-0.1.8 → git_copilot_commit-0.1.10}/README.md

@@ -2,6 +2,8 @@
 
 AI-powered Git commit assistant that generates conventional commit messages using GitHub Copilot.
 
+![](https://github.com/user-attachments/assets/6a6d70a6-6060-44e6-8cf4-a6532e9e9142)
+
 ## Features
 
 - Generates commit messages based on your staged changes
@@ -56,39 +58,54 @@ git-copilot-commit commit
 ### Commit changes
 
 ```bash
-git-copilot-commit commit
-```
-
-**Options:**
-
-- `--all, -a`: Stage all files
-- `--verbose, -v`: Show detailed output
-- `--model, -m`: Choose an AI model
+$ uvx git-copilot-commit commit --help
+Usage: git-copilot-commit commit [OPTIONS]
 
-Workflow:
+  Automatically commit changes in the current git repository.
 
-1. Analyze changes
-2. Prompt to stage files
-3. Generate a commit message
-4. Choose to commit, edit, or cancel
+Options:
+  -a, --all         Stage all files before committing
+  -v, --verbose     Show verbose output
+  -m, --model TEXT  Model to use for generating commit message
+  --help            Show this message and exit.
+```
 
 ### Authenticate
 
 ```bash
-git-copilot-commit authenticate
+$ uvx git-copilot-commit authenticate --help
+Usage: git-copilot-commit authenticate [OPTIONS]
+
+  Autheticate with GitHub Copilot.
+
+Options:
+  --help  Show this message and exit.
 ```
 
 ### List models
 
 ```bash
-git-copilot-commit models
+$ uvx git-copilot-commit models --help
+Usage: git-copilot-commit models [OPTIONS]
+
+  List models available for chat in a table.
+
+Options:
+  --help  Show this message and exit.
 ```
 
 ### Configure
 
 ```bash
-git-copilot-commit config --show
-git-copilot-commit config --set-default-model gpt-4o
+$ uvx git-copilot-commit config --help
+Usage: git-copilot-commit config [OPTIONS]
+
+  Manage application configuration.
+
+Options:
+  --set-default-model TEXT  Set default model for commit messages
+  --show                    Show current configuration
+  --help                    Show this message and exit.
 ```
 
 ## Examples
@@ -139,13 +156,6 @@ Follows [Conventional Commits](https://www.conventionalcommits.org/):
 - `chore`: Maintenance
 - `revert`: Revert changes
 
-**Examples:**
-
-- `feat(auth): add JWT authentication`
-- `fix(db): retry connection on failure`
-- `docs(readme): update install steps`
-- `refactor(utils): simplify date parsing`
-
 ## Git Configuration
 
 Add a git alias by adding the following to your `~/.gitconfig`:
@@ -159,11 +169,11 @@ Now you can run:
 
 ```bash
 git ai-commit
-git ai-commit --model claude-3.5-sonnet
 git ai-commit --all --verbose
+git ai-commit --model claude-3.5-sonnet
 ```
 
-Show more context in diffs:
+Additionally, show more context in diffs by running the following command:
 
 ```bash
 git config --global diff.context 3

{git_copilot_commit-0.1.8 → git_copilot_commit-0.1.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "git-copilot-commit"
-version = "0.1.8"
+version = "0.1.10"
 description = "Automatically generate and commit changes using copilot"
 readme = "README.md"
 authors = [

{git_copilot_commit-0.1.8 → git_copilot_commit-0.1.10}/src/git_copilot_commit/cli.py

@@ -21,7 +21,7 @@ app = typer.Typer(help=__doc__, add_completion=False)
 
 def version_callback(value: bool):
     if value:
-        rich.print(f"git-copilot-version [bold green]{__version__}[/]")
+        rich.print(f"git-copilot-commit [bold green]{__version__}[/]")
         raise typer.Exit()
 
 
@@ -78,9 +78,13 @@ def generate_commit_message(
 ) -> str:
     """Generate a conventional commit message using Copilot API."""
 
-    # Get recent commits for context
-    recent_commits = repo.get_recent_commits(limit=5)
-    recent_commits_text = "\n".join([f"- {msg}" for _, msg in recent_commits])
+    # Get recent commits for context (handle empty repositories)
+    try:
+        recent_commits = repo.get_recent_commits(limit=5)
+        recent_commits_text = "\n".join([f"- {msg}" for _, msg in recent_commits])
+    except GitError:
+        # No commits yet in this repository
+        recent_commits_text = "No previous commits (initial commit)"
 
     client = Copilot(
         system_prompt="""
@@ -172,6 +176,7 @@ Return the commit message as the output without any additional text, explanation
     )
 
     prompt = f"""Recent commits:
+
 {recent_commits_text}
 
 `git status`:
@@ -260,10 +265,14 @@ def commit(
         raise typer.Exit()
 
     # Generate or use provided commit message
-    with console.status("[cyan]Generating commit message...[/cyan]"):
+    with console.status(
+        "[cyan]Generating commit message based on [bold]`git diff --staged`[/bold] ...[/cyan]"
+    ):
         commit_message = generate_commit_message(repo, status, model)
 
-    console.print("[cyan]Generated commit message...[/cyan]")
+    console.print(
+        "[cyan]Generated commit message based on [bold]`git diff --staged`[/bold] ...[/cyan]"
+    )
 
     # Display commit message
     console.print(Panel(commit_message, title="Commit Message", border_style="green"))
@@ -315,7 +324,7 @@ def authenticate():
 
 @app.command()
 def models():
-    """List models available for chat in a Rich table."""
+    """List models available for chat in a table."""
     models = Copilot().models
 
     console = Console()

{git_copilot_commit-0.1.8 → git_copilot_commit-0.1.10}/uv.lock

@@ -57,7 +57,7 @@ wheels = [
 
 [[package]]
 name = "git-copilot-commit"
-version = "0.1.8"
+version = "0.1.10"
 source = { editable = "." }
 dependencies = [
     { name = "platformdirs" },

git_copilot_commit-0.1.10/vhs/demo.vhs

@@ -0,0 +1,35 @@
+# VHS script to showcase git-copilot-commit
+# Run with: vhs < demo.vhs
+
+# Set up the terminal
+Set Shell "bash"
+Set FontSize 14
+Set Width 1200
+Set Height 600
+Set PlaybackSpeed 1.0
+Set TypingSpeed 50ms
+Set Theme "Catppuccin Mocha"
+
+# Show the title
+Type "# git-copilot-commit demo"
+Enter
+Enter
+Sleep 2s
+
+# Demonstrate the tool
+Type "uv run git-copilot-commit commit"
+Enter
+Sleep 5s
+
+Enter # Yes to stage files
+Sleep 5s
+
+Enter # Yes to commit
+Sleep 5s
+
+Type "git log --oneline --graph --all -n 5"
+Enter
+
+Sleep 10s
+
+Output demo.gif