ai_git_utils 0.4.2__py3-none-any.whl

ai_git_utils/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("ai-git-utils")

ai_git_utils/ai_model.py

@@ -0,0 +1,6 @@
+from .config_manager import get_active_model
+
+
+def get_model():
+    active_config = get_active_model()
+    return active_config

ai_git_utils/cli.py

@@ -0,0 +1,322 @@
+import typer
+from rich.console import Console
+from rich.table import Table
+from typing import Optional, List
+from datetime import datetime
+from .config_manager import (
+    add_model_to_config,
+    remove_model_from_config,
+    set_active_model_in_config,
+    get_active_model,
+    load_config,
+)
+from .git_operations import get_git_diff, commit_changes
+from .ai_model import get_model
+from .utils import beautify_diff, edit_commit_message
+from git import Repo
+from git.exc import InvalidGitRepositoryError, GitCommandError
+from .git_operations import get_commit_diff
+from . import __version__
+from openai import OpenAI
+from dataclasses import dataclass, asdict
+import json
+
+
+app = typer.Typer()
+model_app = typer.Typer()
+diff_app = typer.Typer()
+console = Console()
+
+
+@dataclass
+class CommitMessage:
+    type: str
+    scope: str
+    emoji: str
+    subject: str
+    fix_items: List[str]
+
+example_commit = CommitMessage(
+    type="fix",
+    scope="cli",
+    emoji="🐛",
+    subject="segmentation fault in inference",
+    fix_items=["fix segmentation fault in inference"],
+)
+
+
+@model_app.command("add")
+def add_model(
+    name: str = typer.Option(..., prompt=True),
+    model: str = typer.Option(..., prompt=True),
+    base_url: str = typer.Option(..., prompt=True),
+    temperature: float = typer.Option(..., prompt=True),
+    api_key: str = typer.Option(..., prompt=True),
+):
+    """添加新的模型配置"""
+    model_config = {
+        "model": model,
+        "base_url": base_url,
+        "temperature": temperature,
+        "api_key": api_key,
+    }
+    add_model_to_config(name, model_config)
+    typer.echo(f"模型 '{name}' 已添加并激活。")
+
+
+@model_app.command("remove")
+def remove_model(name: str = typer.Option(..., prompt=True)):
+    """删除指定的模型配置"""
+    remove_model_from_config(name)
+    typer.echo(f"模型 '{name}' 已删除。")
+
+
+@model_app.command("active")
+def activate_model(name: str = typer.Option(..., prompt=True)):
+    """激活指定的模型配置"""
+    set_active_model_in_config(name)
+    typer.echo(f"模型 '{name}' 已激活。")
+
+
+@model_app.command("list")
+def list_models():
+    """列出所有可用的模型配置"""
+    config = load_config()
+    active_model = config["active_model"]
+
+    table = Table(title="可用模型配置")
+    table.add_column("模型名称", style="cyan")
+    table.add_column("状态", style="magenta")
+
+    for name in config["models"]:
+        status = "激活" if name == active_model else ""
+        table.add_row(name, status)
+
+    console.print(table)
+
+
+@model_app.command("show")
+def show_config():
+    """显示当前的模型配置"""
+    config = load_config()
+    active_model = config["active_model"]
+
+    if not config["models"]:
+        typer.echo("当前没有保存的模型配置。请运行 'aigit model add' 命令添加模型。")
+        return
+
+    table = Table(title=f"当前激活的模型配置: {active_model}")
+    table.add_column("配置项", style="cyan", no_wrap=True)
+    table.add_column("值", style="magenta")
+
+    active_config = config["models"].get(active_model, {})
+    for key, value in active_config.items():
+        if key == "api_key" and value:
+            value = value[:4] + "*" * (len(value) - 4)
+        table.add_row(key, str(value))
+
+    console.print(table)
+
+
+@app.command()
+def commit(
+    file_path: Optional[str] = typer.Option(None, "--file", "-f", help="指定文件路径"),
+    language: str = typer.Option(
+        "English", "--lang", "-l", help="设置语言（English/Chinese）"
+    ),
+):
+    """
+    使用 AI 智能生成代码更改信息
+    """
+    active_config = get_active_model()
+    if not active_config:
+        typer.echo(
+            "错误：未找到激活的模型配置。请先运行 'aigit model add' 或 'aigit model active' 命令。"
+        )
+        raise typer.Exit(code=1)
+    try:
+        repo = Repo(".")
+        repo.git.add('.')
+        diff_output = get_git_diff(repo, True, file_path)
+
+        if not diff_output:
+            typer.echo("没有检测到更改。")
+        else:
+
+            lite_system_prompt = f'''
+Craft clear and concise commit messages following the Conventional Commits standard format for git. 
+When presented with a git diff summary, your task is to convert it into a useful commit message and add a brief description of the changes made, ensuring that lines are not longer than 74 characters. 
+Your commit message should describe the nature and purpose of the changes in a comprehensive, informative, and concise manner. 
+The commit message should return the json object, keep the content concise and to the point.
+emoji list:
+
+- ✨ New feature
+- 🐛 Fix bug
+- 📚 Documentation update
+- 🚀 Deploy stuff
+- 💄 UI/style update
+- 🎨 Improve structure/format of the code
+- 🔧 Configuration modification
+- 🔥 Delete code/file
+- 🚑 Critical fix
+- ➕ Add dependency
+- ⚡️ Performance improvement
+- ♻️ Refactor code
+- 👷 Add or update CI build system
+
+EXAMPLE JSON OUTPUT:
+{json.dumps(asdict(example_commit), indent=2, ensure_ascii=False)}
+
+output only the json object and answer all my questions in {language}.
+'''
+
+            lite_message_content = f"""git diff summary: \n{diff_output}"""
+            lite_messages = [
+                {"role": "system", "content": lite_system_prompt},
+                {"role": "user", "content": lite_message_content}
+            ]
+
+
+            active_model = get_model()
+            model_name = active_model.get('model')
+
+            client = OpenAI(
+                base_url=active_model.get('base_url'),
+                api_key=active_model.get('api_key'),
+            )
+
+            response = client.chat.completions.create(
+                extra_headers={
+                    "X-Title": "AIGit",
+                },
+                extra_body={},
+                model=model_name,
+                messages=lite_messages,
+                temperature=active_model.get('temperature'),
+                response_format={
+                    'type': 'json_object'
+                }
+            )
+
+            json_str = response.choices[0].message.content
+            try:
+                data = json.loads(json_str)
+            except json.JSONDecodeError:
+                typer.echo("请检查模型是否支持 json 结构化输出。")
+                raise typer.Exit(code=1)
+            commit_message = CommitMessage(**data)
+
+            typer.echo("AI 生成的提交信息：")
+            initial_commit_message = f"""{commit_message.type}({commit_message.scope}): {commit_message.emoji} {commit_message.subject}
+            
+{chr(10).join(f'- {item}' for item in commit_message.fix_items)}
+"""
+            typer.echo()
+            typer.echo("\n请编辑提交信息，保存并关闭编辑器以继续。")
+
+            edited_message = edit_commit_message(initial_commit_message)
+
+            typer.echo("编辑后的提交信息：")
+            typer.echo(edited_message)
+
+            if typer.confirm("确认提交这些更改？"):
+                commit_changes(repo, edited_message)
+                typer.echo("更改已成功提交！")
+            else:
+                typer.echo("提交已取消。")
+
+    except InvalidGitRepositoryError:
+        typer.echo("错误：当前目录不是有效的Git仓库。", err=True)
+    except GitCommandError as e:
+        typer.echo(f"Git命令执行错误：{str(e)}", err=True)
+
+
+@diff_app.command("current")
+def diff(
+    file_path: Optional[str] = typer.Option(None, "--file", "-f", help="指定文件路径"),
+):
+    """
+    查看代码更改
+    """
+    try:
+        repo = Repo(".")
+        repo.git.add('.')
+        diff_output = get_git_diff(repo, True, file_path)
+
+        if not diff_output:
+            typer.echo("没有检测到更改。")
+        else:
+            beautify_diff(diff_output)
+
+    except InvalidGitRepositoryError:
+        typer.echo("错误：当前目录不是有效的Git仓库。", err=True)
+    except GitCommandError as e:
+        typer.echo(f"Git命令执行错误：{str(e)}", err=True)
+
+
+@app.command()
+def log(
+    limit: int = typer.Option(10, "--limit", "-n", help="显示的提交数量"),
+    since: str = typer.Option(
+        None, "--since", "-s", help="显示指定日期之后的提交，格式：YYYY-MM-DD"
+    ),
+    until: str = typer.Option(
+        None, "--until", "-u", help="显示指定日期之前的提交，格式：YYYY-MM-DD"
+    ),
+):
+    """美观地显示git log"""
+    try:
+        repo = Repo(".")
+        commits = repo.iter_commits()
+
+        if since:
+            since_date = datetime.strptime(since, "%Y-%m-%d")
+            commits = filter(lambda c: c.committed_datetime > since_date, commits)
+
+        if until:
+            until_date = datetime.strptime(until, "%Y-%m-%d")
+            commits = filter(lambda c: c.committed_datetime < until_date, commits)
+
+        table = Table(title="Git Log")
+        table.add_column("提交哈希", style="cyan", no_wrap=True)
+        table.add_column("作者", style="magenta")
+        table.add_column("日期", style="green")
+        table.add_column("提交信息", style="yellow")
+
+        for _commit in list(commits)[:limit]:
+            table.add_row(
+                _commit.hexsha[:7],
+                _commit.author.name,
+                _commit.committed_datetime.strftime("%Y-%m-%d %H:%M:%S"),
+                _commit.message.split("\n")[0],
+            )
+
+        console.print(table)
+
+    except InvalidGitRepositoryError:
+        typer.echo("错误：当前目录不是有效的Git仓库。", err=True)
+    except GitCommandError as e:
+        typer.echo(f"Git命令执行错误：{str(e)}", err=True)
+
+
+@diff_app.command("commit")
+def commit_diff(commit_hash: str = typer.Argument(..., help="指定的commit哈希值")):
+    """显示指定commit的diff"""
+    try:
+        repo = Repo(".")
+        diff_output = get_commit_diff(repo, commit_hash)
+        beautify_diff(diff_output)
+    except InvalidGitRepositoryError:
+        typer.echo("错误：当前目录不是有效的Git仓库。", err=True)
+    except GitCommandError as e:
+        typer.echo(f"Git命令执行错误：{str(e)}", err=True)
+
+
+@app.command()
+def version():
+    """显示当前软件版本"""
+    typer.echo(f"AI Git Utils V{__version__}")
+
+
+app.add_typer(model_app, name="model", help="管理AI模型")
+app.add_typer(diff_app, name="diff", help="查看代码更改")

ai_git_utils/config_manager.py

@@ -0,0 +1,50 @@
+import os
+import json
+from typing import Dict, Any
+
+CONFIG_FILE = os.path.expanduser("~/.aigit/model.json")
+
+
+def load_config() -> Dict[str, Any]:
+    if os.path.exists(CONFIG_FILE):
+        with open(CONFIG_FILE, "r") as f:
+            return json.load(f)
+    return {"models": {}, "active_model": None}
+
+
+def save_config(config: Dict[str, Any]) -> None:
+    os.makedirs(os.path.dirname(CONFIG_FILE), exist_ok=True)
+    with open(CONFIG_FILE, "w") as f:
+        json.dump(config, f, indent=2)
+
+
+def add_model_to_config(name: str, model_config: Dict[str, Any]) -> None:
+    config = load_config()
+    config["models"][name] = model_config
+    if config["active_model"] is None:
+        config["active_model"] = name
+    save_config(config)
+
+
+def remove_model_from_config(name: str) -> None:
+    config = load_config()
+    if name in config["models"]:
+        del config["models"][name]
+        if config["active_model"] == name:
+            config["active_model"] = next(iter(config["models"]), None)
+        save_config(config)
+
+
+def set_active_model_in_config(name: str) -> None:
+    config = load_config()
+    if name in config["models"]:
+        config["active_model"] = name
+        save_config(config)
+
+
+def get_active_model() -> Dict[str, Any]:
+    config = load_config()
+    active_model = config["active_model"]
+    if active_model and active_model in config["models"]:
+        return config["models"][active_model]
+    return {}

ai_git_utils/git_operations.py

@@ -0,0 +1,19 @@
+from git import Repo
+from typing import Optional
+
+
+def get_git_diff(repo: Repo, staged: bool = False, file_path: Optional[str] = None):
+    exclude_pattern = ":(exclude)*lock*"
+    if staged:
+        return repo.git.diff("--staged", file_path, exclude_pattern)
+    else:
+        return repo.git.diff(file_path, exclude_pattern)
+
+
+def commit_changes(repo: Repo, commit_message: str):
+    repo.git.add(A=True)
+    repo.index.commit(commit_message)
+
+
+def get_commit_diff(repo: Repo, commit_hash: str):
+    return repo.git.diff(f"{commit_hash}^!", "--word-diff=color")

ai_git_utils/main.py

@@ -0,0 +1,4 @@
+from .cli import app
+
+if __name__ == "__main__":
+    app()

ai_git_utils/utils.py

@@ -0,0 +1,91 @@
+import os
+import tempfile
+import subprocess
+import shutil
+from rich.syntax import Syntax
+from rich.console import Console
+
+console = Console()
+
+ALLOWED_EDITORS = ["vim", "vi", "nano", "emacs", "code", "subl"]
+
+def beautify_diff(diff_output: str) -> None:
+    syntax = Syntax(
+        diff_output,
+        "diff",
+        line_numbers=True,
+        word_wrap=True,
+        indent_guides=False,
+        theme="monokai",
+    )
+    console.print(syntax)
+
+
+def edit_commit_message(initial_message: str) -> str:
+    with tempfile.NamedTemporaryFile(mode="w+", suffix=".tmp", delete=False) as tf:
+        tf.write(initial_message)
+        tf.flush()
+        tf_name = tf.name
+
+    editor_from_env = os.environ.get("EDITOR")
+    editor_to_use = None
+
+    if editor_from_env:
+        # 提取命令的基本名称 (例如 /usr/bin/vim -> vim)
+        editor_basename = os.path.basename(editor_from_env)
+        # 检查基本名称是否在允许列表中，并且该命令确实存在于 PATH 中
+        if editor_basename in ALLOWED_EDITORS and shutil.which(editor_from_env):
+            editor_to_use = editor_from_env
+        else:
+            console.print(f"[yellow]Warning:[/yellow] EDITOR environment variable ('{editor_from_env}') is not in the allowed list ({ALLOWED_EDITORS}) or not found. Falling back to 'vim'.")
+            # Fallback to default if validation fails
+
+    # 如果环境变量未设置或验证失败，则尝试默认的 'vim'
+    if editor_to_use is None:
+        if shutil.which("vim"):
+            editor_to_use = "vim"
+        else:
+            # 如果连 vim 都没有，则需要处理错误情况
+            console.print("[red]Error:[/red] Default editor 'vim' not found. Please install it or set a valid EDITOR environment variable from the allowed list.")
+            os.unlink(tf_name) # 清理临时文件
+            # 根据你的应用逻辑，这里可以抛出异常或返回原始消息
+            # raise RuntimeError("No valid editor found.")
+            return initial_message # 或者简单返回未编辑的消息
+
+    try:
+        # 推荐使用 subprocess.run 替代 subprocess.call
+        # check=True 会在命令返回非零退出码时抛出 CalledProcessError 异常
+        subprocess.run([editor_to_use, tf_name], check=True)
+    except FileNotFoundError:
+        console.print(f"[red]Error:[/red] Editor command '{editor_to_use}' not found. Please check your installation and PATH.")
+        os.unlink(tf_name)
+        return initial_message # 返回未编辑的消息
+    except subprocess.CalledProcessError as e:
+        console.print(f"[red]Error:[/red] Editor '{editor_to_use}' exited with status {e.returncode}.")
+        # 即使编辑器出错，文件可能已被部分修改，但我们通常认为编辑失败
+        os.unlink(tf_name)
+        return initial_message # 返回未编辑的消息
+    except Exception as e:
+        console.print(f"[red]An unexpected error occurred while running the editor:[/red] {e}")
+        os.unlink(tf_name)
+        return initial_message # 返回未编辑的消息
+
+
+    # 确保文件最终被读取和删除
+    edited_message = initial_message # 默认值以防文件读取失败
+    if os.path.exists(tf_name):
+        try:
+            with open(tf_name, "r") as tf:
+                edited_message = tf.read().strip()
+        except Exception as e:
+            console.print(f"[red]Error reading temporary file {tf_name}:[/red] {e}")
+            # 保留原始消息
+        finally:
+            os.unlink(tf_name) # 确保在任何情况下都尝试删除
+    else:
+        console.print(f"[yellow]Warning:[/yellow] Temporary file {tf_name} seems to have been deleted by the editor.")
+        # 在这种情况下，我们无法获取编辑后的消息，返回原始消息
+        edited_message = initial_message
+
+
+    return edited_message

ai_git_utils-0.4.2.dist-info/METADATA

@@ -0,0 +1,109 @@
+Metadata-Version: 2.3
+Name: ai_git_utils
+Version: 0.4.2
+Summary: AI git utils is an intelligent Git commit assistant that leverages AI to enhance your Git workflow.
+Project-URL: Homepage, https://github.com/twn39/aigit
+Project-URL: Documentation, https://github.com/twn39/aigit
+Project-URL: Repository, https://github.com/twn39/aigit
+Project-URL: Source Code, https://github.com/twn39/aigit
+Author-email: curry tang <twn39@163.com>
+Maintainer-email: curry tang <twn39@163.com>
+Keywords: ai,aigit,git
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.11
+Requires-Dist: gitpython>=3.1.45
+Requires-Dist: openai>=1.101.0
+Requires-Dist: pip>=25.2
+Requires-Dist: rich>=14.1.0
+Requires-Dist: setuptools>=80.9.0
+Requires-Dist: typer>=0.16.1
+Description-Content-Type: text/markdown
+
+# AI Git Utils: 智能 Git Commit 助手 🚀
+
+[![PyPI version](https://badge.fury.io/py/ai-git-utils.svg)](https://badge.fury.io/py/ai-git-utils)
+
+**AI Git Utils** 是一个利用 AI 技术增强您 Git 工作流程的智能化工具。它能够根据您的代码变更自动生成规范、清晰且富有表现力的 Commit Message，并智能推荐相关的 Emoji，显著提升版本控制的效率和体验。
+
+![screen](https://raw.githubusercontent.com/twn39/aigit/main/screen.png)
+
+---
+
+## ✨ 核心特性
+
+- **🤖 AI 驱动的 Commit Message 生成:** 基于代码 `diff`，智能生成符合 [Conventional Commits](https://www.conventionalcommits.org/) 规范的提交信息（包含 `type`, `scope`, `subject`, `body`）。
+- **✍️ 交互式编辑:** 在 AI 生成建议后，提供便捷的交互式编辑界面，允许您轻松修改和确认最终的 Commit Message。
+- **😄 智能 Emoji 选择:** 根据 Commit 类型自动推荐合适的 Emoji，让您的提交记录更生动、直观。
+- **🔌 多模型支持与灵活配置:**
+  - 支持接入多种兼容 OpenAI API 标准的大语言模型 (LLM)。
+  - 通过简单的命令行指令即可添加、删除、切换和管理不同的 AI 模型配置。
+- **📜 增强的 Git Log:** 使用 `aigit log` 命令，以美观的表格形式展示提交历史，支持限制数量和时间范围过滤。
+
+---
+
+## 🛠️ 安装
+
+确保您已安装 Python 3.8+。然后通过 pip 安装：
+
+```bash
+pip install ai-git-utils
+```
+
+---
+
+## ⚙️ 配置 AI 模型
+
+在使用 `aigit commit` 功能前，您需要至少配置一个 AI 模型。
+
+1. **添加模型配置:**
+    运行 `aigit model add` 并根据提示输入模型信息：
+
+    ```bash
+    aigit model add
+    # Name: my-gpt4o  (自定义模型名称)
+    # Model: gpt-4o  (模型 ID)
+    # Base Url: https://api.openai.com/v1 (模型服务 API 地址)
+    # Temperature: 0.7 (模型温度参数)
+    # Api Key: sk-xxxx (您的 API 密钥)
+    ```
+
+    添加的第一个模型会自动设为当前激活模型。
+
+2. **管理模型:**
+    - 列出所有已配置模型: `aigit model list`
+    - 查看当前激活模型的详细配置: `aigit model show`
+    - 激活其他已配置模型: `aigit model active` (根据提示输入名称)
+    - 删除指定模型配置: `aigit model remove` (根据提示输入名称)
+
+---
+
+## 🚀 使用指南
+
+### 1. 生成 AI Commit Message (核心功能)
+
+在您的 Git 仓库中，当您有暂存的更改 (staged changes) 时，运行：
+
+```bash
+# 默认使用英文生成
+aigit commit
+
+# 指定使用中文生成
+aigit commit --lang Chinese
+
+# 只针对特定文件的更改生成 commit message
+aigit commit --file path/to/your/file.py
+```
+
+## 🤝 贡献
+
+欢迎各种形式的贡献！如果您有任何建议、发现 Bug 或想改进功能，请随时：
+
+1. Fork 本仓库
+2. 创建您的特性分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交您的更改 (`aigit commit` 😉)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 提交 Pull Request

ai_git_utils-0.4.2.dist-info/RECORD

@@ -0,0 +1,12 @@
+ai_git_utils/__init__.py,sha256=gALy2JYqB4lc5pnAe4itvsSN5dIu8x8-5lZpmSNTnzk,78
+ai_git_utils/ai_model.py,sha256=EUUr8eLmwTdBbnIhoAYENh0TJOiZiruHx6EMgZ3pcp8,128
+ai_git_utils/cli.py,sha256=ABoROjoenxDPr-ZhU2AeXWa_frG4zAZdGbRO0FpEfo4,10414
+ai_git_utils/config_manager.py,sha256=dkaJrL4WiJyNQD3VzlttvlhdNfmmELrARKqcHwXncqg,1439
+ai_git_utils/git_operations.py,sha256=faiwp7LrfOzxkdUWdgUHhU24JdFlV6KT3HtPQseW9j0,565
+ai_git_utils/main.py,sha256=Qd-f8z2Q2vpiEP2x6PBFsJrpACWDVxFKQk820MhFmHo,59
+ai_git_utils/utils.py,sha256=1_VRY5vAuiYpsbROsYmTNkfJwzQ9Qi-bYrtmCQiRAHI,3855
+ai_git_utils-0.4.2.dist-info/METADATA,sha256=ZkgGBg90Xp7IFFkzoI8oKl3nRqMa4VqNT1mDkRqt9mE,4047
+ai_git_utils-0.4.2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+ai_git_utils-0.4.2.dist-info/entry_points.txt,sha256=Sn1zgttLjMOqSGZM1wEVGiD49g6_CG9tcKlkBdfK6Ds,48
+ai_git_utils-0.4.2.dist-info/licenses/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ai_git_utils-0.4.2.dist-info/RECORD,,

ai_git_utils-0.4.2.dist-info/WHEEL

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

ai_git_utils-0.4.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+aigit = ai_git_utils.main:app