git-gcm 1.0.0__tar.gz

git_gcm-1.0.0/LICENSE

@@ -0,0 +1,17 @@
+MIT License
+Copyright (c) 2026 falconluca
+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.

git_gcm-1.0.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: git-gcm
+Version: 1.0.0
+Summary: Git Commit Message 自动生成工具
+Author-email: Luca <yangshaoxiong5545@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/falconluca/gcm
+Project-URL: Repository, https://github.com/falconluca/gcm
+Keywords: git,commit,message,ai,llm,openai,gcm
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+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.8
+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 :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openai>=1.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Dynamic: license-file
+
+# GCM
+
+基于 AI 的 Git Commit Message 自动生成工具，支持所有 OpenAI 协议兼容的大模型服务。
+
+## 安装
+
+```bash
+make build
+```
+
+## 配置
+
+设置环境变量：
+
+```bash
+export GCM_API_KEY="your-api-key"
+export GCM_API_URL="https://api.openai.com/v1"
+export GCM_MODEL="gpt-4o-mini"
+```
+
+## 使用
+
+```bash
+git add .
+gcm           # 生成精简 commit message
+gcm -v        # 生成详细 commit message
+```
+
+## 示例
+
+**精简模式：**
+
+```
+feat(auth): 添加用户登录功能
+```
+
+**详细模式 (`-v`)：**
+
+```
+feat(auth): 添加用户登录功能
+
+- 实现 JWT token 认证
+- 添加登录表单验证
+- 集成第三方 OAuth 登录
+```
+
+## Git 集成
+
+```bash
+git commit -m "$(gcm)"
+```
+
+MIT License

git_gcm-1.0.0/README.md

@@ -0,0 +1,53 @@
+# GCM
+
+基于 AI 的 Git Commit Message 自动生成工具，支持所有 OpenAI 协议兼容的大模型服务。
+
+## 安装
+
+```bash
+make build
+```
+
+## 配置
+
+设置环境变量：
+
+```bash
+export GCM_API_KEY="your-api-key"
+export GCM_API_URL="https://api.openai.com/v1"
+export GCM_MODEL="gpt-4o-mini"
+```
+
+## 使用
+
+```bash
+git add .
+gcm           # 生成精简 commit message
+gcm -v        # 生成详细 commit message
+```
+
+## 示例
+
+**精简模式：**
+
+```
+feat(auth): 添加用户登录功能
+```
+
+**详细模式 (`-v`)：**
+
+```
+feat(auth): 添加用户登录功能
+
+- 实现 JWT token 认证
+- 添加登录表单验证
+- 集成第三方 OAuth 登录
+```
+
+## Git 集成
+
+```bash
+git commit -m "$(gcm)"
+```
+
+MIT License

git_gcm-1.0.0/gcm/__init__.py

@@ -0,0 +1,3 @@
+"""GCM - Git Commit Message Generator"""
+
+__version__ = "0.1.0"

git_gcm-1.0.0/gcm/cli.py

@@ -0,0 +1,179 @@
+"""命令行入口模块"""
+
+import argparse
+import sys
+import os
+from pathlib import Path
+from typing import Optional
+
+from dotenv import load_dotenv
+
+from gcm import __version__
+from gcm.git_utils import (
+    is_git_repo,
+    get_staged_changes,
+    StagedChanges
+)
+from gcm.prompts import build_user_prompt, get_system_prompt
+from gcm.llm_client import LLMClient, LLMConfig
+
+
+def find_env_file() -> Optional[Path]:
+    """查找 .env 文件
+
+    查找顺序:
+    1. 当前目录的 .env
+    2. 父目录（向上查找直到 git 根目录）
+    3. 用户主目录的 .env
+    """
+    # 当前目录
+    env_path = Path.cwd() / ".env"
+    if env_path.exists():
+        return env_path
+
+    # 向上查找直到 git 根目录
+    current = Path.cwd()
+    while current != current.parent:
+        current = current.parent
+        env_path = current / ".env"
+        if env_path.exists():
+            return env_path
+        # 如果找到 .git 目录就停止
+        if (current / ".git").exists():
+            break
+
+    # 用户主目录
+    env_path = Path.home() / ".env"
+    if env_path.exists():
+        return env_path
+
+    return None
+
+
+def load_env_files():
+    """加载 .env 文件"""
+    # 加载用户主目录的 .env（优先级较低）
+    home_env = Path.home() / ".env"
+    if home_env.exists():
+        load_dotenv(home_env)
+
+    # 加载项目目录的 .env（优先级较高）
+    project_env = find_env_file()
+    if project_env:
+        load_dotenv(project_env)
+
+
+def parse_args() -> argparse.Namespace:
+    """解析命令行参数"""
+    parser = argparse.ArgumentParser(
+        prog="gcm",
+        description="自动生成 Git Commit Message"
+    )
+
+    parser.add_argument(
+        "-v", "--verbose",
+        action="store_true",
+        help="生成详细的 commit message"
+    )
+
+    parser.add_argument(
+        "--api-base",
+        type=str,
+        help="API 基础 URL（覆盖 GCM_API_URL）"
+    )
+
+    parser.add_argument(
+        "--api-key",
+        type=str,
+        help="API Key（覆盖 GCM_API_KEY，不推荐在命令行中使用）"
+    )
+
+    parser.add_argument(
+        "-m", "--model",
+        type=str,
+        help="使用的模型名称（覆盖 GCM_MODEL）"
+    )
+
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {__version__}"
+    )
+
+    return parser.parse_args()
+
+
+def generate_commit_message(
+    changes: StagedChanges,
+    client: LLMClient,
+    verbose: bool = False
+) -> str:
+    """生成 commit message
+
+    Args:
+        changes: 暂存区变更
+        client: LLM 客户端
+        verbose: 是否详细模式
+
+    Returns:
+        生成的 commit message
+    """
+    system_prompt = get_system_prompt()
+    user_prompt = build_user_prompt(changes, verbose=verbose)
+
+    return client.chat(system_prompt, user_prompt)
+
+
+def main():
+    """主入口函数"""
+    # 加载 .env 文件
+    load_env_files()
+
+    args = parse_args()
+
+    # 检查是否在 git 仓库中
+    if not is_git_repo():
+        print("错误: 当前目录不在 Git 仓库中", file=sys.stderr)
+        sys.exit(1)
+
+    # 获取暂存区变更
+    changes = get_staged_changes()
+
+    if not changes.files:
+        print("暂存区没有变更。请先使用 'git add' 添加变更。", file=sys.stderr)
+        sys.exit(1)
+
+    # 创建配置（从环境变量加载）
+    config = LLMConfig()
+
+    # 命令行参数覆盖环境变量
+    if args.api_base:
+        config.api_base = args.api_base
+    if args.api_key:
+        config.api_key = args.api_key
+    if args.model:
+        config.model = args.model
+
+    # 创建 LLM 客户端
+    client = LLMClient(config)
+
+    # 生成 commit message
+    try:
+        commit_msg = generate_commit_message(
+            changes,
+            client,
+            verbose=args.verbose
+        )
+    except ValueError as e:
+        print(f"配置错误: {e}", file=sys.stderr)
+        sys.exit(1)
+    except RuntimeError as e:
+        print(f"生成失败: {e}", file=sys.stderr)
+        sys.exit(1)
+
+    # 输出结果
+    print(commit_msg)
+
+
+if __name__ == "__main__":
+    main()

git_gcm-1.0.0/gcm/git_utils.py

@@ -0,0 +1,130 @@
+"""Git 操作工具模块"""
+
+import subprocess
+from dataclasses import dataclass
+from typing import List, Optional
+from pathlib import Path
+
+
+@dataclass
+class FileChange:
+    """文件变更信息"""
+    status: str  # A=新增, M=修改, D=删除, R=重命名
+    old_path: Optional[str]  # 旧路径（重命名时使用）
+    new_path: str  # 新路径
+
+
+@dataclass
+class StagedChanges:
+    """暂存区变更信息"""
+    files: List[FileChange]
+    diff_content: str
+
+
+def is_git_repo() -> bool:
+    """检查当前目录是否在 git 仓库中"""
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", "--is-inside-work-tree"],
+            capture_output=True,
+            text=True,
+            check=False
+        )
+        return result.returncode == 0 and result.stdout.strip() == "true"
+    except FileNotFoundError:
+        return False
+
+
+def get_staged_files() -> List[FileChange]:
+    """获取暂存区的文件列表"""
+    result = subprocess.run(
+        ["git", "diff", "--cached", "--name-status", "--diff-filter=ACDMRT"],
+        capture_output=True,
+        text=True,
+        check=False
+    )
+
+    if result.returncode != 0:
+        return []
+
+    files = []
+    for line in result.stdout.strip().split("\n"):
+        if not line:
+            continue
+
+        parts = line.split("\t")
+        status = parts[0][0]  # 取状态首字母
+
+        if status == "R":
+            # 重命名: R\told_path\tnew_path
+            files.append(FileChange(
+                status=status,
+                old_path=parts[1],
+                new_path=parts[2]
+            ))
+        elif status == "C":
+            # 复制: C\told_path\tnew_path
+            files.append(FileChange(
+                status=status,
+                old_path=parts[1],
+                new_path=parts[2]
+            ))
+        else:
+            # 其他: A/M/D\tpath
+            files.append(FileChange(
+                status=status,
+                old_path=None,
+                new_path=parts[1]
+            ))
+
+    return files
+
+
+def get_staged_diff() -> str:
+    """获取暂存区的详细差异"""
+    result = subprocess.run(
+        ["git", "diff", "--cached"],
+        capture_output=True,
+        text=True,
+        check=False
+    )
+
+    if result.returncode != 0:
+        return ""
+
+    return result.stdout
+
+
+def get_staged_changes(max_diff_lines: int = 500) -> StagedChanges:
+    """获取完整的暂存区变更信息
+
+    Args:
+        max_diff_lines: diff 内容最大行数限制，防止过长
+
+    Returns:
+        StagedChanges 对象
+    """
+    files = get_staged_files()
+    diff = get_staged_diff()
+
+    # 限制 diff 行数
+    if diff:
+        lines = diff.split("\n")
+        if len(lines) > max_diff_lines:
+            diff = "\n".join(lines[:max_diff_lines])
+            diff += f"\n\n... (truncated, {len(lines) - max_diff_lines} more lines)"
+
+    return StagedChanges(files=files, diff_content=diff)
+
+
+def get_status_symbol(status: str) -> str:
+    """获取状态对应的符号/描述"""
+    symbols = {
+        "A": "新增",
+        "M": "修改",
+        "D": "删除",
+        "R": "重命名",
+        "C": "复制",
+        "T": "类型变更"
+    }
+    return symbols.get(status, status)

git_gcm-1.0.0/gcm/llm_client.py

@@ -0,0 +1,84 @@
+"""LLM 客户端模块"""
+
+import os
+from typing import Optional
+from dataclasses import dataclass
+
+from openai import OpenAI
+
+
+@dataclass
+class LLMConfig:
+    """LLM 配置"""
+    api_base: str = "https://api.openai.com/v1"
+    api_key: Optional[str] = None
+    model: str = "gpt-4o-mini"
+    temperature: float = 0.7
+    max_tokens: int = 1000
+    timeout: int = 30
+
+    def __post_init__(self):
+        # 从环境变量获取配置
+        if self.api_key is None:
+            self.api_key = os.environ.get("GCM_API_KEY")
+
+        # 支持 GCM_API_URL 环境变量（兼容智谱等第三方服务）
+        if self.api_base == "https://api.openai.com/v1":
+            self.api_base = os.environ.get("GCM_API_URL", self.api_base)
+
+        # 支持 GCM_MODEL 环境变量
+        if self.model == "gpt-4o-mini":
+            self.model = os.environ.get("GCM_MODEL", self.model)
+
+
+class LLMClient:
+    """与大模型交互的客户端"""
+
+    def __init__(self, config: Optional[LLMConfig] = None):
+        self.config = config or LLMConfig()
+        self._client: Optional[OpenAI] = None
+
+    @property
+    def client(self) -> OpenAI:
+        """懒加载 OpenAI 客户端"""
+        if self._client is None:
+            if not self.config.api_key:
+                raise ValueError(
+                    "API Key 未配置。请设置环境变量 GCM_API_KEY"
+                )
+
+            self._client = OpenAI(
+                api_key=self.config.api_key,
+                base_url=self.config.api_base,
+                timeout=self.config.timeout
+            )
+        return self._client
+
+    def chat(self, system_prompt: str, user_prompt: str) -> str:
+        """发送聊天请求
+
+        Args:
+            system_prompt: 系统提示词
+            user_prompt: 用户提示词
+
+        Returns:
+            模型生成的响应文本
+
+        Raises:
+            ValueError: API Key 未配置
+            RuntimeError: API 调用失败
+        """
+        try:
+            response = self.client.chat.completions.create(
+                model=self.config.model,
+                messages=[
+                    {"role": "system", "content": system_prompt},
+                    {"role": "user", "content": user_prompt}
+                ],
+                temperature=self.config.temperature,
+                max_tokens=self.config.max_tokens
+            )
+            return response.choices[0].message.content
+
+        except Exception as e:
+            raise RuntimeError(f"API 调用失败: {e}")

git_gcm-1.0.0/gcm/prompts.py

@@ -0,0 +1,87 @@
+"""提示词模板模块"""
+
+from gcm.git_utils import StagedChanges, get_status_symbol
+
+
+# 系统提示词
+SYSTEM_PROMPT = """你是一位专业的 Git 提交信息生成助手。你的任务是根据代码变更生成清晰、准确、符合规范的 commit message。
+
+## 输出规则
+
+1. 必须直接输出 commit message，不要有任何前言或解释
+2. commit message 应该使用中文（除非用户指定英文）
+3. 遵循 Conventional Commits 规范
+
+## Commit Message 格式
+
+### 精简模式
+一行简洁的描述，格式：<type>(<scope>): <description>
+
+### 详细模式
+第一行：<type>(<scope>): <description>
+（空行）
+（body，详细描述变更内容和原因）
+（空行）
+（footer，可选，如 Breaking Changes 等）
+
+## Type 类型说明
+- feat: 新功能
+- fix: 修复 bug
+- docs: 文档变更
+- style: 代码格式（不影响代码运行的变动）
+- refactor: 重构（既不是新增功能，也不是修复 bug）
+- perf: 性能优化
+- test: 增加测试
+- chore: 构建过程或辅助工具的变动
+- revert: 回滚
+- ci: CI 配置文件和脚本的变动
+- build: 影响构建系统或外部依赖的变更
+
+## 要求
+- 准确描述变更内容，不要臆测
+- 使用动词原形开头（如：添加、修复、更新、优化）
+- 简洁明了，避免冗余"""
+
+
+def build_user_prompt(changes: StagedChanges, verbose: bool = False) -> str:
+    """构建用户提示词
+
+    Args:
+        changes: 暂存区变更信息
+        verbose: 是否使用详细模式
+
+    Returns:
+        用户提示词字符串
+    """
+    if not changes.files:
+        return "暂存区没有任何变更。"
+
+    # 构建文件变更摘要
+    file_summary = []
+    for file in changes.files:
+        status_text = get_status_symbol(file.status)
+        if file.status in ("R", "C") and file.old_path:
+            file_summary.append(f"- [{status_text}] {file.old_path} -> {file.new_path}")
+        else:
+            file_summary.append(f"- [{status_text}] {file.new_path}")
+
+    # 构建提示词
+    mode = "详细" if verbose else "精简"
+    prompt = f"""请根据以下暂存区变更生成{mode}的 commit message。
+
+## 变更文件
+{chr(10).join(file_summary)}
+
+## 详细变更内容（diff）
+```
+{changes.diff_content}
+```
+
+请生成{mode}的 commit message："""
+
+    return prompt
+
+
+def get_system_prompt() -> str:
+    """获取系统提示词"""
+    return SYSTEM_PROMPT

git_gcm-1.0.0/git_gcm.egg-info/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: git-gcm
+Version: 1.0.0
+Summary: Git Commit Message 自动生成工具
+Author-email: Luca <yangshaoxiong5545@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/falconluca/gcm
+Project-URL: Repository, https://github.com/falconluca/gcm
+Keywords: git,commit,message,ai,llm,openai,gcm
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+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.8
+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 :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openai>=1.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Dynamic: license-file
+
+# GCM
+
+基于 AI 的 Git Commit Message 自动生成工具，支持所有 OpenAI 协议兼容的大模型服务。
+
+## 安装
+
+```bash
+make build
+```
+
+## 配置
+
+设置环境变量：
+
+```bash
+export GCM_API_KEY="your-api-key"
+export GCM_API_URL="https://api.openai.com/v1"
+export GCM_MODEL="gpt-4o-mini"
+```
+
+## 使用
+
+```bash
+git add .
+gcm           # 生成精简 commit message
+gcm -v        # 生成详细 commit message
+```
+
+## 示例
+
+**精简模式：**
+
+```
+feat(auth): 添加用户登录功能
+```
+
+**详细模式 (`-v`)：**
+
+```
+feat(auth): 添加用户登录功能
+
+- 实现 JWT token 认证
+- 添加登录表单验证
+- 集成第三方 OAuth 登录
+```
+
+## Git 集成
+
+```bash
+git commit -m "$(gcm)"
+```
+
+MIT License

git_gcm-1.0.0/git_gcm.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+gcm/__init__.py
+gcm/cli.py
+gcm/git_utils.py
+gcm/llm_client.py
+gcm/prompts.py
+git_gcm.egg-info/PKG-INFO
+git_gcm.egg-info/SOURCES.txt
+git_gcm.egg-info/dependency_links.txt
+git_gcm.egg-info/entry_points.txt
+git_gcm.egg-info/requires.txt
+git_gcm.egg-info/top_level.txt

git_gcm-1.0.0/git_gcm.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

git_gcm-1.0.0/git_gcm.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gcm = gcm.cli:main

git_gcm-1.0.0/git_gcm.egg-info/requires.txt

@@ -0,0 +1,2 @@
+openai>=1.0.0
+python-dotenv>=1.0.0

git_gcm-1.0.0/git_gcm.egg-info/top_level.txt

@@ -0,0 +1 @@
+gcm

git_gcm-1.0.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "git-gcm"
+version = "1.0.0"
+description = "Git Commit Message 自动生成工具"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.8"
+authors = [{ name = "Luca", email = "yangshaoxiong5545@gmail.com" }]
+keywords = ["git", "commit", "message", "ai", "llm", "openai", "gcm"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Version Control :: Git",
+    "Topic :: Utilities",
+]
+dependencies = ["openai>=1.0.0", "python-dotenv>=1.0.0"]
+
+[project.scripts]
+gcm = "gcm.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/falconluca/gcm"
+Repository = "https://github.com/falconluca/gcm"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["gcm*"]

git_gcm-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+