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

git_copilot_commit-0.1.9/PKG-INFO

@@ -0,0 +1,200 @@
+Metadata-Version: 2.4
+Name: git-copilot-commit
+Version: 0.1.9
+Summary: Automatically generate and commit changes using copilot
+Author-email: Dheepak Krishnamurthy <1813121+kdheepak@users.noreply.github.com>
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: pycopilot>=0.1.6
+Requires-Dist: rich>=14.0.0
+Requires-Dist: typer>=0.16.0
+Description-Content-Type: text/markdown
+
+# `git-copilot-commit`
+
+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
+- Supports multiple AI 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 with [`uv`] (recommended):
+
+```bash
+uv tool install git-copilot-commit
+```
+
+Or with `pipx`:
+
+```bash
+pipx install git-copilot-commit
+```
+
+Or run directly with [`uv`]:
+
+```bash
+uvx git-copilot-commit --help
+```
+
+[`uv`]: https://github.com/astral-sh/uv
+
+## Prerequisites
+
+- Active GitHub Copilot subscription
+
+## Quick Start
+
+1. Authenticate with GitHub Copilot:
+
+```bash
+git-copilot-commit authenticate
+```
+
+2. Make changes in your repository.
+
+3. Generate and commit:
+
+```bash
+git-copilot-commit commit
+```
+
+## Usage
+
+### Commit changes
+
+```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
+  -v, --verbose     Show verbose output
+  -m, --model TEXT  Model to use for generating commit message
+  --help            Show this message and exit.
+```
+
+### Authenticate
+
+```bash
+$ 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
+$ uvx git-copilot-commit models --help
+Usage: git-copilot-commit models [OPTIONS]
+
+  List models available for chat in a Rich table.
+
+Options:
+  --help  Show this message and exit.
+```
+
+### Configure
+
+```bash
+$ 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
+
+Commit all changes:
+
+```bash
+git-copilot-commit commit --all
+```
+
+Verbose output:
+
+```bash
+git-copilot-commit commit --verbose
+```
+
+Use a specific model:
+
+```bash
+git-copilot-commit commit --model claude-3.5-sonnet
+```
+
+Set and use a default model:
+
+```bash
+git-copilot-commit config --set-default-model gpt-4o
+git-copilot-commit commit
+git-copilot-commit commit --model claude-3.5-sonnet
+```
+
+## Commit Message Format
+
+Follows [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+<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
+
+**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"
+```
+
+Now you can run:
+
+```bash
+git ai-commit
+git ai-commit --model claude-3.5-sonnet
+git ai-commit --all --verbose
+```
+
+Show more context in diffs:
+
+```bash
+git config --global diff.context 3
+```

git_copilot_commit-0.1.9/README.md

@@ -0,0 +1,187 @@
+# `git-copilot-commit`
+
+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
+- Supports multiple AI 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 with [`uv`] (recommended):
+
+```bash
+uv tool install git-copilot-commit
+```
+
+Or with `pipx`:
+
+```bash
+pipx install git-copilot-commit
+```
+
+Or run directly with [`uv`]:
+
+```bash
+uvx git-copilot-commit --help
+```
+
+[`uv`]: https://github.com/astral-sh/uv
+
+## Prerequisites
+
+- Active GitHub Copilot subscription
+
+## Quick Start
+
+1. Authenticate with GitHub Copilot:
+
+```bash
+git-copilot-commit authenticate
+```
+
+2. Make changes in your repository.
+
+3. Generate and commit:
+
+```bash
+git-copilot-commit commit
+```
+
+## Usage
+
+### Commit changes
+
+```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
+  -v, --verbose     Show verbose output
+  -m, --model TEXT  Model to use for generating commit message
+  --help            Show this message and exit.
+```
+
+### Authenticate
+
+```bash
+$ 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
+$ uvx git-copilot-commit models --help
+Usage: git-copilot-commit models [OPTIONS]
+
+  List models available for chat in a Rich table.
+
+Options:
+  --help  Show this message and exit.
+```
+
+### Configure
+
+```bash
+$ 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
+
+Commit all changes:
+
+```bash
+git-copilot-commit commit --all
+```
+
+Verbose output:
+
+```bash
+git-copilot-commit commit --verbose
+```
+
+Use a specific model:
+
+```bash
+git-copilot-commit commit --model claude-3.5-sonnet
+```
+
+Set and use a default model:
+
+```bash
+git-copilot-commit config --set-default-model gpt-4o
+git-copilot-commit commit
+git-copilot-commit commit --model claude-3.5-sonnet
+```
+
+## Commit Message Format
+
+Follows [Conventional Commits](https://www.conventionalcommits.org/):
+
+```
+<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
+
+**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"
+```
+
+Now you can run:
+
+```bash
+git ai-commit
+git ai-commit --model claude-3.5-sonnet
+git ai-commit --all --verbose
+```
+
+Show more context in diffs:
+
+```bash
+git config --global diff.context 3
+```

{git_copilot_commit-0.1.7 → git_copilot_commit-0.1.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "git-copilot-commit"
-version = "0.1.7"
+version = "0.1.9"
 description = "Automatically generate and commit changes using copilot"
 readme = "README.md"
 authors = [
@@ -11,7 +11,7 @@ dependencies = [
   "pycopilot>=0.1.6",
   "rich>=14.0.0",
   "typer>=0.16.0",
-  "xdg-base-dirs>=6.0.2",
+  "platformdirs>=4.0.0",
 ]
 
 [project.scripts]

{git_copilot_commit-0.1.7 → git_copilot_commit-0.1.9}/src/git_copilot_commit/settings.py

@@ -1,28 +1,30 @@
 """
-Settings management using XDG Base Directory specification.
+Settings management using platformdirs for cross-platform directory paths.
 """
 
 import json
 from typing import Any
 
-from xdg_base_dirs import (
-    xdg_cache_home,
-    xdg_config_home,
-    xdg_data_home,
-    xdg_state_home,
+from platformdirs import (
+    user_cache_dir,
+    user_config_dir,
+    user_data_dir,
+    user_state_dir,
 )
 
 
 class Settings:
-    """Manages application settings using XDG Base Directory specification."""
+    """Manages application settings using platformdirs for cross-platform directory paths."""
 
     APP_NAME = "git-copilot-commit"
 
     def __init__(self):
-        self.config_dir = xdg_config_home() / self.APP_NAME
-        self.data_dir = xdg_data_home() / self.APP_NAME
-        self.cache_dir = xdg_cache_home() / self.APP_NAME
-        self.state_dir = xdg_state_home() / self.APP_NAME
+        from pathlib import Path
+        
+        self.config_dir = Path(user_config_dir(f"com.kdheepak.{self.APP_NAME}"))
+        self.data_dir = Path(user_data_dir(f"com.kdheepak.{self.APP_NAME}"))
+        self.cache_dir = Path(user_cache_dir(f"com.kdheepak.{self.APP_NAME}"))
+        self.state_dir = Path(user_state_dir(f"com.kdheepak.{self.APP_NAME}"))
 
         self.config_file = self.config_dir / "config.json"
 

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

@@ -57,21 +57,21 @@ wheels = [
 
 [[package]]
 name = "git-copilot-commit"
-version = "0.1.7"
+version = "0.1.9"
 source = { editable = "." }
 dependencies = [
+    { name = "platformdirs" },
     { name = "pycopilot" },
     { name = "rich" },
     { name = "typer" },
-    { name = "xdg-base-dirs" },
 ]
 
 [package.metadata]
 requires-dist = [
+    { name = "platformdirs", specifier = ">=4.0.0" },
     { name = "pycopilot", specifier = ">=0.1.6" },
     { name = "rich", specifier = ">=14.0.0" },
     { name = "typer", specifier = ">=0.16.0" },
-    { name = "xdg-base-dirs", specifier = ">=6.0.2" },
 ]
 
 [[package]]
@@ -333,12 +333,3 @@ sdist = { url = "https://files.pythonhosted.org/packages/6c/63/53559446a878410fc
 wheels = [
     { url = "https://files.pythonhosted.org/packages/fd/84/fd2ba7aafacbad3c4201d395674fc6348826569da3c0937e75505ead3528/wcwidth-0.2.13-py2.py3-none-any.whl", hash = "sha256:3da69048e4540d84af32131829ff948f1e022c1c6bdb8d6102117aac784f6859", size = 34166, upload-time = "2024-01-06T02:10:55.763Z" },
 ]
-
-[[package]]
-name = "xdg-base-dirs"
-version = "6.0.2"
-source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/bf/d0/bbe05a15347538aaf9fa5b51ac3b97075dfb834931fcb77d81fbdb69e8f6/xdg_base_dirs-6.0.2.tar.gz", hash = "sha256:950504e14d27cf3c9cb37744680a43bf0ac42efefc4ef4acf98dc736cab2bced", size = 4085, upload-time = "2024-10-19T14:35:08.114Z" }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/fc/03/030b47fd46b60fc87af548e57ff59c2ca84b2a1dadbe721bb0ce33896b2e/xdg_base_dirs-6.0.2-py3-none-any.whl", hash = "sha256:3c01d1b758ed4ace150ac960ac0bd13ce4542b9e2cdf01312dcda5012cfebabe", size = 4747, upload-time = "2024-10-19T14:35:05.931Z" },
-]

git_copilot_commit-0.1.9/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

git_copilot_commit-0.1.7/PKG-INFO

@@ -1,201 +0,0 @@
-Metadata-Version: 2.4
-Name: git-copilot-commit
-Version: 0.1.7
-Summary: Automatically generate and commit changes using copilot
-Author-email: Dheepak Krishnamurthy <1813121+kdheepak@users.noreply.github.com>
-License-File: LICENSE
-Requires-Python: >=3.12
-Requires-Dist: pycopilot>=0.1.6
-Requires-Dist: rich>=14.0.0
-Requires-Dist: typer>=0.16.0
-Requires-Dist: xdg-base-dirs>=6.0.2
-Description-Content-Type: text/markdown
-
-# git-copilot-commit
-
-🤖 AI-powered Git commit assistant that automatically generates conventional commit messages using
-GitHub Copilot.
-
-## Features
-
-- **AI-Generated Commit Messages**: Uses GitHub Copilot to analyze your staged changes and generate
-  conventional commit messages
-- **Multiple AI Models**: Choose from GPT-4, Claude, Gemini, and other available models
-- **Configurable Defaults**: Set a default model to use across all commits
-- **Message Editing**: Edit generated messages using your git-configured editor or commit directly
-- **Conventional Commits**: Follows the [Conventional Commits](https://www.conventionalcommits.org/)
-  specification
-- **Rich Output**: Beautiful terminal output with syntax highlighting and tables
-
-## Installation
-
-Install using uv (recommended):
-
-```bash
-uv tool install git-copilot-commit
-```
-
-Or with pip:
-
-```bash
-pipx install git-copilot-commit
-```
-
-Or without installing:
-
-```bash
-uvx git-copilot-commit --help
-```
-
-## Prerequisites
-
-**GitHub Copilot Access**: You need an active GitHub Copilot subscription
-
-## Quick Start
-
-1. **Authenticate with GitHub Copilot**:
-
-   ```bash
-   git-copilot-commit authenticate
-   ```
-
-2. **Make some changes** in your git repository
-
-3. **Generate and commit**:
-
-   ```bash
-   git-copilot-commit commit
-   ```
-
-## Usage
-
-### `commit`
-
-Automatically commit changes in the current git repository:
-
-```bash
-git-copilot-commit commit
-```
-
-**Options:**
-
-- `--all, -a`: Stage all files before committing
-- `--verbose, -v`: Show verbose output with file details
-- `--model, -m`: Specify which AI model to use for generating the commit message
-
-1. The tool analyzes your changes
-2. Prompts you to stage files (if needed)
-3. Generates an AI-powered commit message
-4. Offers three choices:
-   - `(c)ommit`: Commit with the generated message
-   - `(e)dit`: Edit the message in your git-configured editor
-   - `(q)uit`: Cancel the commit
-
-### `authenticate`
-
-Set up authentication with GitHub Copilot:
-
-```bash
-git-copilot-commit authenticate
-```
-
-### `models`
-
-List available AI models:
-
-```bash
-git-copilot-commit models
-```
-
-### `config`
-
-Manage application configuration:
-
-```bash
-# Show current configuration
-git-copilot-commit config --show
-
-# Set a default model for all commits
-git-copilot-commit config --set-default-model gpt-4o
-```
-
-## Examples
-
-**Commit all changes with staging prompts:**
-
-```bash
-git-copilot-commit commit --all
-```
-
-**Commit with verbose output:**
-
-```bash
-git-copilot-commit commit --verbose
-```
-
-**Use a specific AI model:**
-
-```bash
-git-copilot-commit commit --model claude-3.5-sonnet
-```
-
-**Set up a default model and use it:**
-
-```bash
-# Set default model once
-git-copilot-commit config --set-default-model gpt-4o
-
-# Now all commits will use gpt-4o by default
-git-copilot-commit commit
-
-# Override with a different model when needed
-git-copilot-commit commit --model claude-3.5-sonnet
-```
-
-## Generated Commit Message Format
-
-The tool follows the [Conventional Commits](https://www.conventionalcommits.org/) specification:
-
-```
-<type>[optional scope]: <description>
-```
-
-**Supported Types:**
-
-- `feat`: A new feature
-- `fix`: A bug fix
-- `docs`: Documentation changes
-- `style`: Code formatting (no logic changes)
-- `refactor`: Code restructuring (no behavior changes)
-- `perf`: Performance improvements
-- `test`: Adding or updating tests
-- `chore`: Maintenance tasks (tooling, dependencies, etc.)
-- `revert`: Reverting previous changes
-
-**Example Messages:**
-
-- `feat(auth): add user authentication with JWT`
-- `fix(database): handle connection retries properly`
-- `docs(readme): update installation instructions`
-- `refactor(utils): simplify date parsing logic`
-
-## Git Configuration
-
-For the best experience with git-copilot-commit, consider adding this alias for the commit command:
-
-```bash
-# Add a git alias for quick access
-git config --global alias.ai-commit "!git-copilot-commit commit"
-
-# Now you can use:
-git ai-commit
-git ai-commit --model claude-3.5-sonnet
-git ai-commit --all --verbose
-```
-
-You can also configure git to show more context in diffs, which can help when reviewing changes:
-
-```bash
-# Show more context in diffs
-git config --global diff.context 3
-```

git_copilot_commit-0.1.7/README.md

@@ -1,188 +0,0 @@
-# git-copilot-commit
-
-🤖 AI-powered Git commit assistant that automatically generates conventional commit messages using
-GitHub Copilot.
-
-## Features
-
-- **AI-Generated Commit Messages**: Uses GitHub Copilot to analyze your staged changes and generate
-  conventional commit messages
-- **Multiple AI Models**: Choose from GPT-4, Claude, Gemini, and other available models
-- **Configurable Defaults**: Set a default model to use across all commits
-- **Message Editing**: Edit generated messages using your git-configured editor or commit directly
-- **Conventional Commits**: Follows the [Conventional Commits](https://www.conventionalcommits.org/)
-  specification
-- **Rich Output**: Beautiful terminal output with syntax highlighting and tables
-
-## Installation
-
-Install using uv (recommended):
-
-```bash
-uv tool install git-copilot-commit
-```
-
-Or with pip:
-
-```bash
-pipx install git-copilot-commit
-```
-
-Or without installing:
-
-```bash
-uvx git-copilot-commit --help
-```
-
-## Prerequisites
-
-**GitHub Copilot Access**: You need an active GitHub Copilot subscription
-
-## Quick Start
-
-1. **Authenticate with GitHub Copilot**:
-
-   ```bash
-   git-copilot-commit authenticate
-   ```
-
-2. **Make some changes** in your git repository
-
-3. **Generate and commit**:
-
-   ```bash
-   git-copilot-commit commit
-   ```
-
-## Usage
-
-### `commit`
-
-Automatically commit changes in the current git repository:
-
-```bash
-git-copilot-commit commit
-```
-
-**Options:**
-
-- `--all, -a`: Stage all files before committing
-- `--verbose, -v`: Show verbose output with file details
-- `--model, -m`: Specify which AI model to use for generating the commit message
-
-1. The tool analyzes your changes
-2. Prompts you to stage files (if needed)
-3. Generates an AI-powered commit message
-4. Offers three choices:
-   - `(c)ommit`: Commit with the generated message
-   - `(e)dit`: Edit the message in your git-configured editor
-   - `(q)uit`: Cancel the commit
-
-### `authenticate`
-
-Set up authentication with GitHub Copilot:
-
-```bash
-git-copilot-commit authenticate
-```
-
-### `models`
-
-List available AI models:
-
-```bash
-git-copilot-commit models
-```
-
-### `config`
-
-Manage application configuration:
-
-```bash
-# Show current configuration
-git-copilot-commit config --show
-
-# Set a default model for all commits
-git-copilot-commit config --set-default-model gpt-4o
-```
-
-## Examples
-
-**Commit all changes with staging prompts:**
-
-```bash
-git-copilot-commit commit --all
-```
-
-**Commit with verbose output:**
-
-```bash
-git-copilot-commit commit --verbose
-```
-
-**Use a specific AI model:**
-
-```bash
-git-copilot-commit commit --model claude-3.5-sonnet
-```
-
-**Set up a default model and use it:**
-
-```bash
-# Set default model once
-git-copilot-commit config --set-default-model gpt-4o
-
-# Now all commits will use gpt-4o by default
-git-copilot-commit commit
-
-# Override with a different model when needed
-git-copilot-commit commit --model claude-3.5-sonnet
-```
-
-## Generated Commit Message Format
-
-The tool follows the [Conventional Commits](https://www.conventionalcommits.org/) specification:
-
-```
-<type>[optional scope]: <description>
-```
-
-**Supported Types:**
-
-- `feat`: A new feature
-- `fix`: A bug fix
-- `docs`: Documentation changes
-- `style`: Code formatting (no logic changes)
-- `refactor`: Code restructuring (no behavior changes)
-- `perf`: Performance improvements
-- `test`: Adding or updating tests
-- `chore`: Maintenance tasks (tooling, dependencies, etc.)
-- `revert`: Reverting previous changes
-
-**Example Messages:**
-
-- `feat(auth): add user authentication with JWT`
-- `fix(database): handle connection retries properly`
-- `docs(readme): update installation instructions`
-- `refactor(utils): simplify date parsing logic`
-
-## Git Configuration
-
-For the best experience with git-copilot-commit, consider adding this alias for the commit command:
-
-```bash
-# Add a git alias for quick access
-git config --global alias.ai-commit "!git-copilot-commit commit"
-
-# Now you can use:
-git ai-commit
-git ai-commit --model claude-3.5-sonnet
-git ai-commit --all --verbose
-```
-
-You can also configure git to show more context in diffs, which can help when reviewing changes:
-
-```bash
-# Show more context in diffs
-git config --global diff.context 3
-```