enhanced-git 1.0.0__py3-none-any.whl

enhanced_git-1.0.0.dist-info/METADATA

@@ -0,0 +1,349 @@
+Metadata-Version: 2.4
+Name: enhanced-git
+Version: 1.0.0
+Summary: Generate Conventional Commit messages and changelog sections using AI
+Project-URL: Homepage, https://github.com/mxzahid/git-ai
+Project-URL: Repository, https://github.com/mxzahid/git-ai
+Project-URL: Issues, https://github.com/mxzahid/git-ai/issues
+Project-URL: Documentation, https://github.com/mxzahid/git-ai#readme
+Author-email: Abdullah Zahid <abdullahzahid229@gmail.com>
+Maintainer-email: Abdullah Zahid <abdullahzahid229@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: ai,changelog,commit,conventional-commits,git,llm
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: gitpython>=3.1.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: tomli>=2.0.0; python_version < '3.11'
+Requires-Dist: typer>=0.9.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: types-requests>=2.31.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.0.0; extra == 'docs'
+Requires-Dist: mkdocs>=1.5.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# Git-AI
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+
+Generate Conventional Commit messages and changelog sections using AI. Simple to install, works with
+Use Local models with Ollama or OpenAI, gracefully degrades when no AI is available.
+
+## Features
+
+- **AI-Powered**: Generate commit messages using OpenAI or local Ollama models
+- **Conventional Commits**: Follows strict Conventional Commit formatting rules
+- **Changelog Generation**: Create Keep a Changelog formatted sections
+- **Git Hook Integration**: Automatic commit message generation on `git commit`
+- **Fallback Mode**: Works without AI using intelligent heuristics
+- **Cross-Platform**: Linux, macOS support
+- **Zero Dependencies**: Single Python package, minimal runtime deps
+
+## Quick Start (60 seconds)
+
+### Install
+
+```bash
+# using pipx (recommended)
+pipx install git-ai
+
+# or using pip
+pip install git-ai
+```
+
+### Setup (Optional AI Integration)
+
+**With OpenAI:**
+```bash
+export OPENAI_API_KEY="your-api-key-here"
+```
+
+**With Ollama (Local AI):**
+```bash
+# install Ollama and pull a model
+ollama pull qwen2.5-coder:3b
+
+# set environment variables
+export OLLAMA_BASE_URL="http://localhost:11434"
+export OLLAMA_MODEL="qwen2.5-coder:3b"
+```
+
+### Basic Usage
+
+```bash
+# stage some changes
+git add .
+
+# Install Git hook for automatic generation
+git-ai hook install
+
+#if using git-ai hook, then just do git commit -m "some sample message"
+#if not using git-ai hook use this:
+git commit -m "$(git-ai commit)"
+
+
+# generate changelog
+git-ai changelog --since v1.0.0 --version v1.1.0
+```
+
+## Usage
+
+### Commands
+
+#### `git-ai commit`
+
+Generate a commit message from staged changes.
+
+```bash
+# Basic usage
+git-ai commit
+
+# Preview without committing
+git-ai commit --dry-run
+
+# Subject line only
+git-ai commit --no-body
+
+# Force plain style (no conventional format)
+git-ai commit --style plain
+
+# Used by Git hook
+git-ai commit --hook /path/to/.git/COMMIT_EDITMSG
+```
+
+#### `git-ai hook install`
+
+Install Git hook for automatic commit message generation.
+
+```bash
+# Install hook
+git-ai hook install
+
+# Force overwrite existing hook
+git-ai hook install --force
+
+# Remove hook
+git-ai hook uninstall
+```
+
+#### `git-ai changelog`
+
+Generate changelog section from commit history.
+
+```bash
+# generate changelog from commits since v1.0.0
+git-ai changelog --since v1.0.0
+
+# with version header
+git-ai changelog --since v1.0.0 --version v1.1.0
+
+# custom output file
+git-ai changelog --since v1.0.0 --output HISTORY.md
+
+# different end reference
+git-ai changelog --since v1.0.0 --to main
+```
+
+### Environment Variables
+
+- `OPENAI_API_KEY`: Your OpenAI API key
+- `OLLAMA_BASE_URL`: Ollama server URL (default: http://localhost:11434)
+- `OLLAMA_MODEL`: Ollama model name (default: qwen2.5-coder:3b)
+
+## How It Works
+
+### Commit Message Generation
+
+1. **Diff Analysis**: Parses `git diff --staged` to understand changes
+2. **Type Inference**: Detects commit type from file paths and content:
+   - `tests/` → `test`
+   - `docs/` → `docs`
+   - `fix`/`bug` in content → `fix`
+   - New files → `feat`
+3. **AI Enhancement**: Uses LLM to polish the message while preserving accuracy
+4. **Formatting**: Ensures Conventional Commit compliance:
+   - Subject < 70 chars
+   - `type(scope): description` format
+   - Proper body wrapping at 72 columns
+
+### Changelog Generation
+
+1. **Commit Parsing**: Extracts commits between references
+2. **Grouping**: Groups by Conventional Commit types
+3. **AI Polish**: Improves clarity while preserving facts
+4. **Insertion**: Adds new section to top of CHANGELOG.md
+
+### Fallback Mode
+
+When no AI is configured, GitAI uses intelligent heuristics:
+
+- Path-based type detection
+- Content analysis for keywords
+- Statistical analysis of changes
+- Scope inference from directory structure
+
+## Development
+
+### Setup
+
+```bash
+# clone repository
+git clone https://github.com/yourusername/git-ai.git
+cd gitai
+
+# install with dev dependencies
+pip install -e ".[dev]"
+
+# run tests
+pytest
+
+# run linting
+ruff check .
+mypy gitai
+```
+
+### Project Structure
+
+```
+gitai/
+├── cli.py              # Main CLI entry point
+├── commit.py           # Commit message generation
+├── changelog.py        # Changelog generation
+├── config.py           # Configuration management
+├── constants.py        # Prompts and constants
+├── diff.py             # Git diff parsing and chunking
+├── hook.py             # Git hook management
+├── providers/          # LLM providers
+│   ├── base.py
+│   ├── openai_provider.py
+│   └── ollama_provider.py
+├── util.py             # Utility functions
+└── __init__.py
+
+tests/                  # Test suite
+├── test_commit.py
+├── test_changelog.py
+├── test_diff.py
+└── test_hook_integration.py
+```
+
+## Contributing
+
+I welcome contributions! Be kind
+
+### Development Requirements
+
+- Python 3.11+
+- Poetry for dependency management
+- Pre-commit for code quality
+
+### Testing
+
+```bash
+# run test suite
+pytest
+
+# with coverage
+pytest --cov=gitai --cov-report=html
+
+# run specific tests
+pytest tests/test_commit.py -v
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Privacy & Security
+
+- **No Code Storage**: Your code never leaves your machine
+- **Local AI Option**: Use Ollama for complete local processing
+- **API Usage**: Only sends commit diffs and prompts to configured LLM
+- **Graceful Degradation**: Works without any network access
+
+## Troubleshooting
+
+### No staged changes
+```
+Error: No staged changes found. Did you forget to run 'git add'?
+```
+**Solution**: Stage your changes with `git add` before running `git-ai commit`
+
+### Missing API key
+```
+Warning: OPENAI_API_KEY environment variable is required
+```
+**Solution**: Set your API key or use Ollama for local AI
+
+### Hook conflicts
+```
+Warning: Existing commit-msg hook found
+```
+**Solution**: Use `git-ai hook install --force` to overwrite, or manually merge
+
+### Network timeouts
+```
+Error: Ollama API error: Connection timeout
+```
+**Solution**: Check Ollama is running: `ollama serve`
+
+### Large diffs
+GitAI automatically chunks large diffs to stay within LLM token limits
+
+## Examples
+
+### Example Commit Messages
+
+**AI-Generated:**
+```
+feat(auth): add user registration and login system
+
+- Implement user registration with email validation
+- Add login endpoint with JWT token generation
+- Create password hashing utilities
+- Add input validation and error handling
+```
+
+**Fallback Mode:**
+```
+feat(src): add user authentication module
+
+- add src/auth.py (45 additions)
+- update src/models.py (12 additions, 3 deletions)
+```
+
+### Example Changelog
+
+```markdown
+## [v1.1.0] - 2024-01-15
+
+### Features
+- **auth**: Add user registration and login system (#123)
+- **api**: Implement RESTful user management endpoints
+
+### Fixes
+- **core**: Fix null pointer exception in user validation (#456)
+- **db**: Resolve connection timeout issues
+
+### Documentation
+- Update API documentation with authentication examples
+- Add installation instructions for local development
+```

enhanced_git-1.0.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+gitai/__init__.py,sha256=X_3SlMT2EeGvZ9bdsXdjzwd1FFta8HHakgPv6yRq7kU,108
+gitai/changelog.py,sha256=F2atDczLs-HgoafHOngKC6m2BhlfVYmknHyCIPjjFL4,8724
+gitai/cli.py,sha256=l0i6UKqdeHB3TDAgaY8Gq1N-GFM4QrI2h72m9EWzY-I,4453
+gitai/commit.py,sha256=vVfMcXDCOSc90ILMm8wMg0PjLiuUarzteyI2I_IT76c,12257
+gitai/config.py,sha256=uOE1AyMadaPVsGJoFDLR2TJoZsYT28Q0SmQHLK-_Wyk,3543
+gitai/constants.py,sha256=smipnjD7Y8h11Io1bpnimue-bz21opM74MHxczOq3rQ,3201
+gitai/diff.py,sha256=Ae3aslHoeVrYDYo1UVnZe5x-z5poFUCM8K9bXRfVyug,5107
+gitai/hook.py,sha256=U4KF1_uJZuw6AKtsyCcnntJcBOIsHNxZF149DYjgQDk,2527
+gitai/util.py,sha256=8FS8jS7dJqedrjYsXwgXX3QHWBPxRigK22OAjcXCSqI,3718
+gitai/providers/__init__.py,sha256=6IFc912-oepXeDGJyE4Ksm3KJLn6CGdYZb8HkUMfvlA,31
+gitai/providers/base.py,sha256=a5b1ZulBnQvVmTlxeUQhixMyFWhwiZKMX1sIeQHHkms,1851
+gitai/providers/ollama_provider.py,sha256=crRCfQZxJY1S4LaSFdiNT19u2T9WjbhpU8TCxbuo92w,2540
+gitai/providers/openai_provider.py,sha256=i1lwyCtWoN5APt3UsB4MBS-jOLifDZcUCGj1Ko1CKcs,2444
+enhanced_git-1.0.0.dist-info/METADATA,sha256=3_-WQqGFOr8KheBVmvNj3wazlV7bALYCzJfjmFnfXD0,8950
+enhanced_git-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+enhanced_git-1.0.0.dist-info/entry_points.txt,sha256=y59MLN9OtRqEzDRPiC0tThQ9DKLAO_hkTWOBCMTqKXM,47
+enhanced_git-1.0.0.dist-info/licenses/LICENSE,sha256=d11_Oc9IT-MUTvztUzbHPs_CSr9drf-6d1vnIvPiMJc,1075
+enhanced_git-1.0.0.dist-info/RECORD,,

enhanced_git-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

enhanced_git-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+enhanced-git = gitai.cli:app

enhanced_git-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 GitAI Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gitai/__init__.py

@@ -0,0 +1,3 @@
+"""GitAI - Generate Conventional Commit messages and changelog sections using AI."""
+
+__version__ = "1.0.0"

gitai/changelog.py

@@ -0,0 +1,251 @@
+"""Changelog generation functionality."""
+
+import re
+from collections import defaultdict
+from datetime import datetime
+from pathlib import Path
+
+from .config import Config
+from .constants import (
+    CHANGELOG_SECTIONS,
+    CHANGELOG_SYSTEM_PROMPT,
+    CHANGELOG_USER_PROMPT,
+    CHANGELOG_WRAP_WIDTH,
+    TYPE_TO_SECTION,
+)
+from .diff import get_commit_history
+from .providers.base import create_provider
+from .util import wrap_text
+
+
+class ChangelogGenerator:
+    """Generates changelog sections from commit history."""
+
+    def __init__(self, config: Config):
+        self.config = config
+        self.provider = None
+
+        # Initialize LLM provider if available
+        if config.is_llm_available():
+            try:
+                if config.llm.provider == "openai":
+                    self.provider = create_provider(
+                        "openai",
+                        api_key=config.llm.api_key,
+                        base_url=config.llm.base_url,
+                        model=config.llm.model,
+                        timeout=config.llm.timeout_seconds,
+                    )
+                elif config.llm.provider == "ollama":
+                    self.provider = create_provider(
+                        "ollama",
+                        base_url=config.llm.base_url,
+                        model=config.llm.model,
+                        timeout=config.llm.timeout_seconds,
+                    )
+            except Exception:
+                self.provider = None
+
+    def generate_changelog(
+        self,
+        since_ref: str,
+        to_ref: str = "HEAD",
+        version: str | None = None,
+        output_path: Path | None = None,
+    ) -> str:
+        """Generate changelog section from commits between refs."""
+        commits = get_commit_history(since_ref, to_ref)
+
+        if not commits:
+            return "No commits found in the specified range."
+
+        # Parse and group commits
+        grouped_commits = self._group_commits(commits)
+
+        # Generate raw changelog content
+        changelog_content = self._generate_raw_changelog(grouped_commits, version)
+
+        # Polish with LLM if available
+        if self.provider and grouped_commits:
+            try:
+                changelog_content = self._polish_with_llm(changelog_content)
+            except Exception:
+                # Fall back to raw content on LLM failure
+                pass
+
+        # Insert into existing CHANGELOG.md if it exists
+        if output_path:
+            return self._insert_into_changelog(changelog_content, output_path)
+        else:
+            # Default to CHANGELOG.md in git root
+            default_path = self.config.git_root / "CHANGELOG.md"
+            return self._insert_into_changelog(changelog_content, default_path)
+
+    def _group_commits(self, commits: list[dict[str, str]]) -> dict[str, list[str]]:
+        """Group commits by type for changelog sections."""
+        grouped = defaultdict(list)
+
+        for commit in commits:
+            subject = commit["subject"]
+            body = commit.get("body", "")
+
+            # Parse conventional commit format: type(scope): description
+            match = re.match(r"^(\w+)(?:\(([^)]+)\))?:\s*(.+)$", subject)
+            if match:
+                commit_type = match.group(1)
+                scope = match.group(2)
+                description = match.group(3)
+
+                # Map to changelog section
+                section = TYPE_TO_SECTION.get(commit_type, "Other")
+
+                # Include scope if present
+                if scope:
+                    description = f"**{scope}:** {description}"
+
+                # Add PR/issue references from body
+                pr_refs = self._extract_pr_references(body)
+                if pr_refs:
+                    description += f" ({pr_refs})"
+
+                grouped[section].append(description)
+            else:
+                # Non-conventional commit
+                grouped["Other"].append(subject)
+
+        return dict(grouped)
+
+    def _generate_raw_changelog(
+        self, grouped_commits: dict[str, list[str]], version: str | None
+    ) -> str:
+        """Generate raw changelog content from grouped commits."""
+        lines = []
+
+        # Add header
+        if version:
+            lines.append(f"## [{version}] - {datetime.now().strftime('%Y-%m-%d')}")
+        else:
+            lines.append(f"## {datetime.now().strftime('%Y-%m-%d')}")
+
+        lines.append("")
+
+        # Add sections in order
+        for section in CHANGELOG_SECTIONS:
+            if section in grouped_commits:
+                lines.append(f"### {section}")
+                lines.append("")
+
+                for item in grouped_commits[section]:
+                    # Wrap long lines
+                    wrapped_item = wrap_text(item, CHANGELOG_WRAP_WIDTH)
+                    lines.append(f"- {wrapped_item}")
+
+                lines.append("")
+
+        return "\n".join(lines)
+
+    def _polish_with_llm(self, raw_changelog: str) -> str:
+        """Polish changelog content using LLM."""
+        if not self.provider:
+            return raw_changelog
+        lines = raw_changelog.split("\n")
+        header_lines = []
+        content_lines = []
+
+        in_content = False
+        for line in lines:
+            if line.startswith("### "):
+                in_content = True
+            if in_content:
+                content_lines.append(line)
+            else:
+                header_lines.append(line)
+
+        if not content_lines:
+            return raw_changelog
+
+        grouped_bullets = "\n".join(content_lines)
+
+        prompt = CHANGELOG_USER_PROMPT.format(grouped_bullets=grouped_bullets)
+        if self.config.debug_settings.debug_mode:
+            print("Sending changelog to LLM for polishing...")
+            print(f"System: {CHANGELOG_SYSTEM_PROMPT}")
+            print(f"User: {prompt}")
+            print("-" * 50)
+
+        polished_content = self.provider.generate(
+            system=CHANGELOG_SYSTEM_PROMPT,
+            user=prompt,
+            max_tokens=self.config.llm.max_tokens,
+            temperature=self.config.llm.temperature,
+            timeout=self.config.llm.timeout_seconds,
+        )
+        if self.config.debug_settings.debug_mode:
+            print(f"LLM polished response: {polished_content}")
+            print("-" * 50)
+
+        polished_lines = []
+        for line in polished_content.split("\n"):
+            line = line.strip()
+            if line and not line.startswith("```"):
+                if not line.startswith("- "):
+                    line = f"- {line}"
+                polished_lines.append(line)
+
+        return "\n".join(header_lines) + "\n" + "\n".join(polished_lines) + "\n"
+
+    def _insert_into_changelog(self, new_content: str, changelog_path: Path) -> str:
+        """Insert new changelog content at the top of existing file."""
+        if not changelog_path.exists():
+            # create new changelog file
+            changelog_path.write_text(new_content + "\n")
+            return f"Created new changelog at {changelog_path}"
+
+        # read existing content
+        existing_content = changelog_path.read_text()
+
+        # find the first header to insert before it
+        lines = existing_content.split("\n")
+        insert_index = 0
+
+        for i, line in enumerate(lines):
+            if line.startswith("# "):
+                insert_index = i
+                break
+
+        # insert new content
+        new_lines = new_content.split("\n")
+        updated_lines = lines[:insert_index] + new_lines + [""] + lines[insert_index:]
+
+        # write back to file
+        changelog_path.write_text("\n".join(updated_lines))
+
+        return f"Updated changelog at {changelog_path}"
+
+    def _extract_pr_references(self, body: str) -> str:
+        """Extract PR and issue references from commit body."""
+        references = []
+
+        # common patterns for PR/issue references
+        patterns = [
+            r"#(\d+)",
+            r"\b(PR|Pull Request|Issue|Fixes|Closes)\s*#?(\d+)\b",
+            r"\bGH-(\d+)\b",
+        ]
+
+        for pattern in patterns:
+            matches = re.findall(pattern, body, re.IGNORECASE)
+            for match in matches:
+                if isinstance(match, tuple):
+                    # for patterns with capture groups
+                    ref_num = match[1] if len(match) > 1 else match[0]
+                    references.append(f"#{ref_num}")
+                else:
+                    references.append(f"#{match}")
+
+        # remove duplicates and return
+        def extract_number(ref: str) -> int:
+            match = re.match(r"#(\d+)", ref)
+            return int(match.group(1)) if match else 0
+
+        return ", ".join(sorted(set(references), key=extract_number))