diffron 0.1.0__py3-none-any.whl

diffron/utils.py

@@ -0,0 +1,236 @@
+"""
+Shared utilities for Diffron.
+
+Provides common functions for port scanning, Git operations, and file handling.
+"""
+
+import subprocess
+import socket
+from typing import List, Optional
+import psutil
+
+
+COMMON_PORTS = [8000, 8001, 8080, 8081, 5000, 5001]
+
+
+def scan_ports(ports: Optional[List[int]] = None, host: str = "localhost") -> List[int]:
+    """
+    Scan for open ports on the given host.
+
+    Args:
+        ports: List of ports to scan. Defaults to COMMON_PORTS.
+        host: Host to scan. Defaults to localhost.
+
+    Returns:
+        List of open ports.
+    """
+    if ports is None:
+        ports = COMMON_PORTS
+
+    open_ports = []
+    for port in ports:
+        if is_port_open(host, port):
+            open_ports.append(port)
+
+    return open_ports
+
+
+def is_port_open(host: str, port: int, timeout: float = 1.0) -> bool:
+    """
+    Check if a port is open on the given host.
+
+    Args:
+        host: Host to check.
+        port: Port number to check.
+        timeout: Connection timeout in seconds.
+
+    Returns:
+        True if port is open, False otherwise.
+    """
+    try:
+        with socket.create_connection((host, port), timeout=timeout):
+            return True
+    except (socket.timeout, ConnectionRefusedError, OSError):
+        return False
+
+
+def get_staged_diff(max_chars: int = 4000) -> str:
+    """
+    Get the staged git diff.
+
+    Args:
+        max_chars: Maximum number of characters to return.
+
+    Returns:
+        Staged diff as string, truncated to max_chars.
+    """
+    try:
+        result = subprocess.run(
+            ["git", "diff", "--cached"],
+            capture_output=True,
+            text=True,
+            errors="ignore",
+            timeout=30,
+        )
+        diff = result.stdout[:max_chars]
+        return diff
+    except (subprocess.SubprocessError, FileNotFoundError):
+        return ""
+
+
+def get_branch_diff(branch: str, base: str = "main", max_chars: int = 5000) -> str:
+    """
+    Get the diff between a branch and its base.
+
+    Args:
+        branch: Branch name to compare.
+        base: Base branch to compare against.
+        max_chars: Maximum number of characters to return.
+
+    Returns:
+        Diff as string, truncated to max_chars.
+    """
+    try:
+        result = subprocess.run(
+            ["git", "diff", f"{base}..{branch}"],
+            capture_output=True,
+            text=True,
+            errors="ignore",
+            timeout=30,
+        )
+        diff = result.stdout[:max_chars]
+        return diff
+    except (subprocess.SubprocessError, FileNotFoundError):
+        return ""
+
+
+def get_commit_log(branch: str, base: str = "main") -> str:
+    """
+    Get the commit log between a branch and its base.
+
+    Args:
+        branch: Branch name.
+        base: Base branch.
+
+    Returns:
+        Commit log as string (oneline format).
+    """
+    try:
+        result = subprocess.run(
+            ["git", "log", "--oneline", f"{base}..{branch}"],
+            capture_output=True,
+            text=True,
+            errors="ignore",
+            timeout=30,
+        )
+        return result.stdout
+    except (subprocess.SubprocessError, FileNotFoundError):
+        return ""
+
+
+def get_current_branch() -> Optional[str]:
+    """
+    Get the current git branch name.
+
+    Returns:
+        Branch name or None if not in a git repo.
+    """
+    try:
+        result = subprocess.run(
+            ["git", "symbolic-ref", "--short", "HEAD"],
+            capture_output=True,
+            text=True,
+            errors="ignore",
+            timeout=10,
+        )
+        if result.returncode == 0:
+            return result.stdout.strip()
+    except (subprocess.SubprocessError, FileNotFoundError):
+        pass
+    return None
+
+
+def is_git_repo(path: str = ".") -> bool:
+    """
+    Check if the given path is inside a git repository.
+
+    Args:
+        path: Path to check.
+
+    Returns:
+        True if inside a git repo, False otherwise.
+    """
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", "--git-dir"],
+            capture_output=True,
+            text=True,
+            cwd=path,
+            timeout=10,
+        )
+        return result.returncode == 0
+    except (subprocess.SubprocessError, FileNotFoundError):
+        return False
+
+
+def get_git_dir(path: str = ".") -> Optional[str]:
+    """
+    Get the .git directory path.
+
+    Args:
+        path: Path to check.
+
+    Returns:
+        Absolute path to .git directory or None.
+    """
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", "--git-dir"],
+            capture_output=True,
+            text=True,
+            cwd=path,
+            timeout=10,
+        )
+        if result.returncode == 0:
+            git_dir = result.stdout.strip()
+            # Convert to absolute path
+            import os
+            if not os.path.isabs(git_dir):
+                git_dir = os.path.abspath(os.path.join(path, git_dir))
+            return git_dir
+    except (subprocess.SubprocessError, FileNotFoundError):
+        pass
+    return None
+
+
+def find_default_branch() -> str:
+    """
+    Find the default branch (main or master).
+
+    Returns:
+        Default branch name.
+    """
+    try:
+        # Try main first (modern default)
+        result = subprocess.run(
+            ["git", "rev-parse", "--verify", "main"],
+            capture_output=True,
+            text=True,
+            timeout=10,
+        )
+        if result.returncode == 0:
+            return "main"
+
+        # Fall back to master
+        result = subprocess.run(
+            ["git", "rev-parse", "--verify", "master"],
+            capture_output=True,
+            text=True,
+            timeout=10,
+        )
+        if result.returncode == 0:
+            return "master"
+    except (subprocess.SubprocessError, FileNotFoundError):
+        pass
+
+    return "main"  # Default to main

diffron/utils.pyi

@@ -0,0 +1,58 @@
+"""
+Shared utilities for Diffron.
+
+Provides common functions for port scanning, Git operations, and file handling.
+"""
+
+from typing import List, Optional
+
+
+COMMON_PORTS: List[int]
+
+
+def scan_ports(
+    ports: Optional[List[int]] = None,
+    host: str = "localhost"
+) -> List[int]:
+    """Scan for open ports on the given host."""
+    ...
+
+
+def is_port_open(host: str, port: int, timeout: float = 1.0) -> bool:
+    """Check if a port is open on the given host."""
+    ...
+
+
+def get_staged_diff(max_chars: int = 4000) -> str:
+    """Get the staged git diff."""
+    ...
+
+
+def get_branch_diff(branch: str, base: str = "main", max_chars: int = 5000) -> str:
+    """Get the diff between a branch and its base."""
+    ...
+
+
+def get_commit_log(branch: str, base: str = "main") -> str:
+    """Get the commit log between a branch and its base."""
+    ...
+
+
+def get_current_branch() -> Optional[str]:
+    """Get the current git branch name."""
+    ...
+
+
+def is_git_repo(path: str = ".") -> bool:
+    """Check if the given path is inside a git repository."""
+    ...
+
+
+def get_git_dir(path: str = ".") -> Optional[str]:
+    """Get the .git directory path."""
+    ...
+
+
+def find_default_branch() -> str:
+    """Find the default branch (main or master)."""
+    ...

diffron-0.1.0.dist-info/METADATA

@@ -0,0 +1,373 @@
+Metadata-Version: 2.4
+Name: diffron
+Version: 0.1.0
+Summary: Git commit message and PR description generator using Lemonade
+Home-page: https://github.com/diffron/diffron
+Author: Diffron Contributors
+Author-email: Diffron Contributors <diffron@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/diffron/diffron
+Project-URL: Documentation, https://github.com/diffron/diffron/docs
+Project-URL: Repository, https://github.com/diffron/diffron
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openai>=1.0.0
+Requires-Dist: psutil>=5.9.0
+Provides-Extra: git
+Requires-Dist: gitpython>=3.1.0; extra == "git"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Diffron
+
+Git commit message and PR description generator using AMD Lemonade via lemonade-python-sdk.
+
+**This is a demo project showcasing the lemonade-python-sdk - submitted to the AMD Lemonade Developer Challenge 2026.**
+
+![Version](https://img.shields.io/badge/version-0.1.0-blue)
+![Python](https://img.shields.io/badge/python-3.9+-blue)
+![License](https://img.shields.io/badge/license-MIT-green)
+![Platform](https://img.shields.io/badge/platform-Windows-lightgrey)
+
+---
+
+## Features
+
+- 🤖 **Auto Commit Messages** - Generates Conventional Commits format messages from your staged changes
+- 📝 **PR Descriptions** - Creates detailed PR titles and descriptions from branch diffs
+- 🔌 **Lemonade Integration** - Works with your local Lemonade LLM server (no cloud required)
+- 🪟 **Windows Ready** - Fully compatible with GitHub Desktop 3.5.5+ hooks support
+- ⚡ **Auto-Detection** - Automatically finds your running Lemonade instance
+- 🎯 **Model Flexible** - Use any Lemonade-compatible model (default: qwen2.5-it-3b-FLM)
+
+---
+
+## Quick Start
+
+### 1. Install AMD Lemonade Server
+
+**Lemonade is AMD's local LLM server for Ryzen AI PCs.**
+
+1. Download the installer from [AMD Lemonade Releases](https://github.com/AMD-AI-Software/lemonade/releases)
+2. Run `Lemonade_Server_Installer.exe`
+3. Launch Lemonade Server from the desktop shortcut
+4. Download a model via the Lemonade UI (e.g., `qwen2.5-it-3b-FLM`)
+
+📚 **Documentation:** [AMD Ryzen AI - Lemonade Setup](https://ryzenai.docs.amd.com/en/latest/llm/server_interface.html)
+
+### 2. Install lemonade-python-sdk
+
+**Our Python SDK for AMD Lemonade API:**
+
+```bash
+pip install lemonade-sdk
+```
+
+🔗 **Source:** [github.com/Tetramatrix/lemonade-python-sdk](https://github.com/Tetramatrix/lemonade-python-sdk)
+
+### 3. Configure Environment
+
+**Set Lemonade Server URL (Permanent):**
+1. System Properties → Environment Variables
+2. New User Variable:
+   - Name: `LEMONADE_SERVER_URL`
+   - Value: `http://localhost:8020`
+
+**Or Temporary (current session):**
+```cmd
+set LEMONADE_SERVER_URL=http://localhost:8020
+```
+
+### 4. Install Diffron
+
+```bash
+pip install diffron
+```
+
+### 5. Install Git Hooks
+
+```bash
+python -c "from diffron.git_hooks import install_hooks; install_hooks(global_install=True)"
+```
+
+### 6. Test It
+
+```bash
+# Make a change
+echo "test" > test.txt
+git add test.txt
+
+# Commit - hooks generate the message automatically!
+git commit -m "anything"
+```
+
+Expected output:
+```
+[master abc123] feat: add test.txt file
+ 1 file changed, 1 insertion(+)
+```
+
+---
+
+## Installation
+
+### Requirements
+
+| Software | Version | Purpose |
+|----------|---------|---------|
+| Python | 3.9+ | Runtime |
+| Git | 2.0+ | Version control |
+| GitHub Desktop | 3.5.5+ | Git GUI (Windows) |
+| lemonade-sdk | Latest | AMD Lemonade API client |
+| Lemonade | Latest | Local LLM server |
+
+### Full Installation Guide
+
+See [docs/SETUP.md](docs/SETUP.md) for detailed Windows-specific instructions.
+
+---
+
+## Usage
+
+### CLI Commands
+
+```bash
+# Install hooks globally
+python -c "from diffron.git_hooks import install_hooks; install_hooks(global_install=True)"
+
+# Generate PR description
+python -c "from diffron import generate_pr_description; pr = generate_pr_description(); print(pr.format_output())"
+
+# Check status
+python -c "from diffron import is_lemonade_running, is_hooks_installed; print('Lemonade:', is_lemonade_running()); print('Hooks:', is_hooks_installed(check_global=True))"
+```
+
+### Python API
+
+```python
+from diffron import DiffronClient
+
+# Create client
+client = DiffronClient()
+
+# Generate commit message
+msg = client.generate_commit_message()
+print(msg)  # "feat: add user authentication"
+
+# Generate PR description
+pr = client.generate_pr_description(branch="feature/my-feature")
+print(f"TITLE: {pr.title}")
+print(f"DESCRIPTION: {pr.description}")
+
+# Install hooks
+client.install_hooks(global_install=True)
+```
+
+### GitHub Desktop Workflow
+
+1. Make changes to your files
+2. Open GitHub Desktop
+3. Enter any commit message (e.g., "auto")
+4. Click "Commit to main"
+5. **Diffron replaces** your message with AI-generated message
+
+---
+
+## Configuration
+
+### Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `LEMONADE_SERVER_URL` | `http://localhost:8020` | Lemonade server URL |
+| `DIFFRON_MODEL` | `qwen2.5-it-3b-FLM` | Model name to use |
+| `DIFFRON_MAX_DIFF_CHARS` | `4000` | Max diff characters |
+
+### Change Model
+
+```cmd
+# System-wide
+setx DIFFRON_MODEL "qwen2.5-coder-7b"
+
+# Current session
+set DIFFRON_MODEL=qwen2.5-coder-7b
+```
+
+### Python API
+
+```python
+from diffron import DiffronClient
+
+# Use different model
+client = DiffronClient(model="your-model-name")
+```
+
+---
+
+## Documentation
+
+| Document | Description |
+|----------|-------------|
+| [SETUP.md](docs/SETUP.md) | Complete installation guide for Windows |
+| [HOOKS.md](docs/HOOKS.md) | Git hooks architecture and internals |
+| [USAGE.md](docs/USAGE.md) | Detailed usage examples |
+
+---
+
+## Related Projects
+
+### Tetramatrix Projects
+
+| Project | Description |
+|---------|-------------|
+| **lemonade-python-sdk** | 🍋 **AMD Lemonade Challenge Submission** - Python SDK for AMD Lemonade API |
+| **Diffron** | Demo project showcasing lemonade-python-sdk (this repo) |
+| **Aicono** | AI Assistant (Desktop App) |
+| **TabNeuron** | Browser Connector / Memory |
+| **Sorana** | Advanced AI Interface |
+| **RyzenPilot** | Hardware Optimization |
+
+**Note:** Lemonade is AMD's local LLM server for Ryzen AI PCs. Diffron uses `lemonade-python-sdk` to communicate with Lemonade's API.
+
+🏆 **AMD Lemonade Developer Challenge 2026:** This project demonstrates the capabilities of lemonade-python-sdk as a real-world application built on AMD Lemonade.
+
+---
+
+## How It Works
+
+```
+┌─────────────────────────────────────────────────────────┐
+│ 1. User makes changes and runs: git commit              │
+└─────────────────────────────────────────────────────────┘
+                          ↓
+┌─────────────────────────────────────────────────────────┐
+│ 2. Git hook executes prepare-commit-msg                 │
+│    - Location: C:/Users/Name/.diffron-hooks/            │
+└─────────────────────────────────────────────────────────┘
+                          ↓
+┌─────────────────────────────────────────────────────────┐
+│ 3. Hook reads staged diff: git diff --cached            │
+└─────────────────────────────────────────────────────────┘
+                          ↓
+┌─────────────────────────────────────────────────────────┐
+│ 4. Hook calls Lemonade API                              │
+│    - URL: http://localhost:8020/api/v1                  │
+│    - Model: qwen2.5-it-3b-FLM                           │
+└─────────────────────────────────────────────────────────┘
+                          ↓
+┌─────────────────────────────────────────────────────────┐
+│ 5. AI generates Conventional Commit message             │
+│    - "feat: add user authentication module"             │
+└─────────────────────────────────────────────────────────┘
+                          ↓
+┌─────────────────────────────────────────────────────────┐
+│ 6. Git opens editor with generated message              │
+│    - User can review/modify before saving               │
+└─────────────────────────────────────────────────────────┘
+```
+
+---
+
+## Troubleshooting
+
+### Lemonade Not Detected
+
+```bash
+# Start Lemonade
+lemonade serve qwen2.5-it-3b-FLM
+
+# Verify URL
+echo %LEMONADE_SERVER_URL%
+```
+
+### Hooks Not Working
+
+```bash
+# Check GitHub Desktop version (must be 3.5.5+)
+# Help → About
+
+# Verify hooks path
+git config --global core.hooksPath
+
+# Reinstall hooks
+python -c "from diffron.git_hooks import install_hooks; install_hooks(global_install=True)"
+```
+
+### Model Not Found (404)
+
+```bash
+# Download model
+lemonade pull qwen2.5-it-3b-FLM
+
+# Verify model name
+set DIFFRON_MODEL=qwen2.5-it-3b-FLM
+```
+
+See [docs/SETUP.md](docs/SETUP.md) for complete troubleshooting guide.
+
+---
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+---
+
+## Contributing
+
+Contributions welcome! This is an open source project.
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests
+5. Submit a pull request
+
+### Development Setup
+
+```bash
+git clone https://github.com/diffron/diffron.git
+cd diffron
+pip install -e ".[dev]"
+```
+
+### Run Tests
+
+```bash
+pytest tests/
+```
+
+---
+
+## Acknowledgments
+
+- **Lemonade** - Local LLM server by the Lemonade team
+- **GitHub Desktop** - Git GUI with hooks support (3.5.5+)
+- **Conventional Commits** - Commit message format specification
+
+---
+
+*Version: 0.1.0 | Last updated: 2026-03-28*

diffron-0.1.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+diffron/__init__.py,sha256=zWh5clvGKqkTWP4i5BuG4uzzBAV0WOz5cb66noH3n6w,730
+diffron/__init__.pyi,sha256=narREZbkyqZeyb6uFKMqSJDjdisbP7bwdH6I_qpk8Ik,712
+diffron/cli.py,sha256=-bVwq_gdepyBgGiNutSO7VZOkzR56bBdF_eCa5ldo6Y,9673
+diffron/cli.pyi,sha256=DRx5Uvg9YoOfLIzhCRArLHXpddaADZoose94oOSxHu8,550
+diffron/client.py,sha256=6C69FGEiqMPhL_qVfpXjV-V4tsIyTssxwXKdzF-FPzA,5122
+diffron/client.pyi,sha256=eEcSY2kJHiuYcKGJ7KnaIcvY92xlm4b-yXV9ITf4GBg,2087
+diffron/commit_gen.py,sha256=IJTadg5ttvWFl0X1aLREprHvBr4AAHlhKLMxN2fMjT4,4560
+diffron/commit_gen.pyi,sha256=-3MZezLNCfXIHzsIQdiWYVZ_1gMBzH51vH9pnICpKmc,949
+diffron/git_hooks.py,sha256=ScyEfwZVID4yuniRVEEBOoVWqQ2tzvoR2kJPLTjoqFQ,8218
+diffron/git_hooks.pyi,sha256=HPMhxzGG3-Jqsnn95fwWU535-IiQAR1faRD9HcpJvAI,1027
+diffron/lemonade.py,sha256=y1YUWLWlrEiyTnn_YJVrc8qU3-2990hORGj-IMNoTlA,5600
+diffron/lemonade.pyi,sha256=Z3dvqsstOwA5eHTu2oBXmaECyCBZLz-RmzsHDwRXlUM,1350
+diffron/pr_gen.py,sha256=84qZUf1IXsxv27HxCfqi5yFvJ6lOeCaK87KlDVVNwVA,6560
+diffron/pr_gen.pyi,sha256=oMm9Q9cNwzT9kpAhaWqiGMZxnpdCteyPQdV-eai0c98,1317
+diffron/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+diffron/utils.py,sha256=-YbCIm8rAGiDBYZahMZgUJ17r3NlpEX-FX97nsz5mp0,5831
+diffron/utils.pyi,sha256=LnxeTcOSucvfg4jszVBI8cYHoqUnkgaOiK4PmUJKPU8,1251
+diffron-0.1.0.dist-info/licenses/LICENSE,sha256=Lyind8rORjrnAcM4YCvqvlklEUaeZSTzqmA2QiRrAGY,1077
+docs/HOOKS.md,sha256=2l138u33rcQeBFEIhpOcECneg2HHMs7EdQ1JCDtWxKQ,13778
+docs/PLAN.md,sha256=_fBS3zWcaxcW4Npss66-YLDn_lrAZyhSnjreTLK8cfU,11217
+docs/PYPI_RELEASE.md,sha256=sl_vT6x_piPNDfymfCHNpM_j0OwY3ZGbxRAMUy8RCa4,8729
+docs/SETUP.md,sha256=Uy_1_AGN0i4JPigPquZWb2YXijd5Yzz-Fn5zwcgTfEs,13023
+docs/USAGE.md,sha256=hYDQQZdKcUIUUrdDG51LVzHduMQgxwNNdYGBvOgMea8,9878
+diffron-0.1.0.dist-info/METADATA,sha256=tAYHQcHWd1zDPdpRpkmOkFRPXgsXcK_1Z_1IXrxkF9Q,12136
+diffron-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+diffron-0.1.0.dist-info/entry_points.txt,sha256=IRWRl2dBVxsXKNcV45trz4E22WjDDAI1xr5U8_CILmA,214
+diffron-0.1.0.dist-info/top_level.txt,sha256=xRWBliiMzDBMb-K_izgUOMcVqj88-EXLhZbJU4Nl-EA,13
+diffron-0.1.0.dist-info/RECORD,,

diffron-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

diffron-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+diffron-install-hooks = diffron.cli:install_hooks_cli
+diffron-pr = diffron.cli:pr_description_cli
+diffron-status = diffron.cli:status_cli
+diffron-uninstall-hooks = diffron.cli:uninstall_hooks_cli