git-copilot-commit 0.1.9__tar.gz → 0.1.11__tar.gz

{git_copilot_commit-0.1.9 → git_copilot_commit-0.1.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-copilot-commit
-Version: 0.1.9
+Version: 0.1.11
 Summary: Automatically generate and commit changes using copilot
 Author-email: Dheepak Krishnamurthy <1813121+kdheepak@users.noreply.github.com>
 License-File: LICENSE
@@ -15,7 +15,7 @@ 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)
+![Screenshot of git-copilot-commit in action](https://github.com/user-attachments/assets/6a6d70a6-6060-44e6-8cf4-a6532e9e9142)
 
 ## Features
 
@@ -26,26 +26,49 @@ AI-powered Git commit assistant that generates conventional commit messages usin
 
 ## Installation
 
-Install with [`uv`] (recommended):
+### Install the tool using [`uv`] (recommended)
+
+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"
+```
+
+Then install `git-copilot-commit`:
+
+```bash
+# Install into isolated environment.
 uv tool install git-copilot-commit
 ```
 
-Or with `pipx`:
+Run the tool using:
 
 ```bash
-pipx install git-copilot-commit
+git-copilot-commit --help
 ```
 
-Or run directly with [`uv`]:
+Alternatively, you can always install and run the latest version of tool directly in one command by
+using:
 
 ```bash
+# Install latest version into temporary environment and run
 uvx 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
@@ -54,17 +77,23 @@ uvx git-copilot-commit --help
 
 1. Authenticate with GitHub Copilot:
 
-```bash
-git-copilot-commit authenticate
-```
+   ```bash
+   git-copilot-commit authenticate
+   ```
 
 2. Make changes in your repository.
 
 3. Generate and commit:
 
-```bash
-git-copilot-commit commit
-```
+   ```bash
+   git-copilot-commit commit
+   ```
+
+4. Or, if you want to stage all files before committing use:
+
+   ```bash
+   git-copilot-commit commit --all
+   ```
 
 ## Usage
 
@@ -101,7 +130,7 @@ Options:
 $ uvx git-copilot-commit models --help
 Usage: git-copilot-commit models [OPTIONS]
 
-  List models available for chat in a Rich table.
+  List models available for chat in a table.
 
 Options:
   --help  Show this message and exit.
@@ -153,7 +182,7 @@ git-copilot-commit commit --model claude-3.5-sonnet
 
 Follows [Conventional Commits](https://www.conventionalcommits.org/):
 
-```
+```plaintext
 <type>[optional scope]: <description>
 ```
 
@@ -169,31 +198,24 @@ 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`:
 
 ```ini
 [alias]
-    ai-commit = "!f() { git-copilot-commit commit $@; }; f"
+    ai-commit = "!f() { uvx git-copilot-commit commit $@; }; f"
 ```
 
 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.9 → git_copilot_commit-0.1.11}/README.md

@@ -2,7 +2,7 @@
 
 AI-powered Git commit assistant that generates conventional commit messages using GitHub Copilot.
 
-![](https://github.com/user-attachments/assets/6a6d70a6-6060-44e6-8cf4-a6532e9e9142)
+![Screenshot of git-copilot-commit in action](https://github.com/user-attachments/assets/6a6d70a6-6060-44e6-8cf4-a6532e9e9142)
 
 ## Features
 
@@ -13,26 +13,49 @@ AI-powered Git commit assistant that generates conventional commit messages usin
 
 ## Installation
 
-Install with [`uv`] (recommended):
+### Install the tool using [`uv`] (recommended)
+
+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"
+```
+
+Then install `git-copilot-commit`:
+
+```bash
+# Install into isolated environment.
 uv tool install git-copilot-commit
 ```
 
-Or with `pipx`:
+Run the tool using:
 
 ```bash
-pipx install git-copilot-commit
+git-copilot-commit --help
 ```
 
-Or run directly with [`uv`]:
+Alternatively, you can always install and run the latest version of tool directly in one command by
+using:
 
 ```bash
+# Install latest version into temporary environment and run
 uvx 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
@@ -41,17 +64,23 @@ uvx git-copilot-commit --help
 
 1. Authenticate with GitHub Copilot:
 
-```bash
-git-copilot-commit authenticate
-```
+   ```bash
+   git-copilot-commit authenticate
+   ```
 
 2. Make changes in your repository.
 
 3. Generate and commit:
 
-```bash
-git-copilot-commit commit
-```
+   ```bash
+   git-copilot-commit commit
+   ```
+
+4. Or, if you want to stage all files before committing use:
+
+   ```bash
+   git-copilot-commit commit --all
+   ```
 
 ## Usage
 
@@ -88,7 +117,7 @@ Options:
 $ uvx git-copilot-commit models --help
 Usage: git-copilot-commit models [OPTIONS]
 
-  List models available for chat in a Rich table.
+  List models available for chat in a table.
 
 Options:
   --help  Show this message and exit.
@@ -140,7 +169,7 @@ git-copilot-commit commit --model claude-3.5-sonnet
 
 Follows [Conventional Commits](https://www.conventionalcommits.org/):
 
-```
+```plaintext
 <type>[optional scope]: <description>
 ```
 
@@ -156,31 +185,24 @@ 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`:
 
 ```ini
 [alias]
-    ai-commit = "!f() { git-copilot-commit commit $@; }; f"
+    ai-commit = "!f() { uvx git-copilot-commit commit $@; }; f"
 ```
 
 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.11/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "git-copilot-commit"
+dynamic = ["version"]
+description = "Automatically generate and commit changes using copilot"
+readme = "README.md"
+authors = [
+  { name = "Dheepak Krishnamurthy", email = "1813121+kdheepak@users.noreply.github.com" },
+]
+requires-python = ">=3.12"
+dependencies = [
+  "pycopilot>=0.1.6",
+  "rich>=14.0.0",
+  "typer>=0.16.0",
+  "platformdirs>=4.0.0",
+]
+
+[project.scripts]
+git-copilot-commit = "git_copilot_commit.cli:app"
+
+[build-system]
+requires = ["hatchling", "versioningit"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "versioningit"
+
+[tool.versioningit.next-version]
+method = "smallest"
+
+[tool.versioningit.format]
+distance = "{next_version}.dev{distance}+{vcs}{rev}"
+# Example formatted version: 1.2.4.dev42+ge174a1f
+
+dirty = "{base_version}+d{build_date:%Y%m%d}"
+# Example formatted version: 1.2.3+d20230922
+
+distance-dirty = "{next_version}.dev{distance}+{vcs}{rev}.d{build_date:%Y%m%d}"
+# Example formatted version: 1.2.4.dev42+ge174a1f.d20230922

{git_copilot_commit-0.1.9 → git_copilot_commit-0.1.11}/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.11/src/git_copilot_commit/version.py

@@ -0,0 +1,3 @@
+import importlib.metadata
+
+__version__ = importlib.metadata.version(__package__)

{git_copilot_commit-0.1.9 → git_copilot_commit-0.1.11}/uv.lock

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

git_copilot_commit-0.1.9/pyproject.toml

@@ -1,108 +0,0 @@
-[project]
-name = "git-copilot-commit"
-version = "0.1.9"
-description = "Automatically generate and commit changes using copilot"
-readme = "README.md"
-authors = [
-  { name = "Dheepak Krishnamurthy", email = "1813121+kdheepak@users.noreply.github.com" },
-]
-requires-python = ">=3.12"
-dependencies = [
-  "pycopilot>=0.1.6",
-  "rich>=14.0.0",
-  "typer>=0.16.0",
-  "platformdirs>=4.0.0",
-]
-
-[project.scripts]
-git-copilot-commit = "git_copilot_commit.cli:app"
-
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[tool.semantic_release]
-assets = []
-build_command_env = []
-commit_message = "{version}\n\nAutomatically generated by python-semantic-release"
-commit_parser = "conventional"
-logging_use_named_masks = false
-major_on_zero = true
-allow_zero_version = false
-repo_dir = "."
-no_git_verify = false
-tag_format = "v{version}"
-version_toml = ["pyproject.toml:project.version"]
-
-[tool.semantic_release.branches.main]
-match = "(main|master)"
-prerelease_token = "rc"
-prerelease = false
-
-[tool.semantic_release.changelog]
-changelog_file = ""
-exclude_commit_patterns = []
-mode = "update"
-insertion_flag = "<!-- version list -->"
-template_dir = "templates"
-
-[tool.semantic_release.changelog.default_templates]
-changelog_file = "CHANGELOG.md"
-output_format = "md"
-mask_initial_release = true
-
-[tool.semantic_release.changelog.environment]
-block_start_string = "{%"
-block_end_string = "%}"
-variable_start_string = "{{"
-variable_end_string = "}}"
-comment_start_string = "{#"
-comment_end_string = "#}"
-trim_blocks = false
-lstrip_blocks = false
-newline_sequence = "\n"
-keep_trailing_newline = false
-extensions = []
-autoescape = false
-
-[tool.semantic_release.commit_author]
-env = "GIT_COMMIT_AUTHOR"
-default = "semantic-release <semantic-release>"
-
-[tool.semantic_release.commit_parser_options]
-minor_tags = ["feat"]
-patch_tags = ["fix", "perf"]
-other_allowed_tags = [
-  "build",
-  "chore",
-  "ci",
-  "docs",
-  "style",
-  "refactor",
-  "test",
-]
-allowed_tags = [
-  "feat",
-  "fix",
-  "perf",
-  "build",
-  "chore",
-  "ci",
-  "docs",
-  "style",
-  "refactor",
-  "test",
-]
-default_bump_level = 0
-parse_squash_commits = true
-ignore_merge_commits = true
-
-[tool.semantic_release.remote]
-name = "origin"
-type = "github"
-ignore_token_for_push = false
-insecure = false
-
-[tool.semantic_release.publish]
-dist_glob_patterns = ["dist/*"]
-upload_to_vcs_release = true

git_copilot_commit-0.1.9/src/git_copilot_commit/version.py

@@ -1,40 +0,0 @@
-import subprocess
-import shlex
-from importlib import metadata
-import os
-
-
-DIR = os.path.dirname(os.path.realpath(__file__))
-
-VERSION = metadata.version(__package__ or "git-copilot-commit")
-
-
-def cmd(cmd, kind="") -> str:
-    """
-    Get git subprocess output
-    """
-    output = "unknown"
-    try:
-        output = (
-            subprocess.check_output(shlex.split(cmd), cwd=DIR, stderr=subprocess.STDOUT)
-            .decode()
-            .strip()
-        )
-    except Exception as _:
-        ...
-    return f"{kind}{output}"
-
-
-def last_commit_id() -> str:
-    return cmd("git describe --always --dirty --abbrev=7")
-
-
-def branch() -> str:
-    return cmd("git rev-parse --abbrev-ref HEAD")
-
-
-def get_git_version() -> str:
-    return f"{last_commit_id()}-{branch()}"
-
-
-__version__ = f"v{VERSION}-{get_git_version()}"