git-gcm 2.0.0__tar.gz → 2.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: git-gcm
3
- Version: 2.0.0
3
+ Version: 2.0.1
4
4
  Summary: Write Git commits the smart way.
5
5
  Author-email: Luca <yangshaoxiong5545@gmail.com>
6
6
  License: MIT
@@ -32,17 +32,20 @@ Dynamic: license-file
32
32
 
33
33
  [![PyPI version](https://badge.fury.io/py/git-gcm.svg)](https://pypi.org/project/git-gcm/)
34
34
 
35
- 基于大模型的 Git Commit Message 生成,支持所有 OpenAI 协议兼容的大模型服务
35
+ 基于大模型的 Git Commit Message 生成,支持所有 OpenAI 协议兼容的服务。
36
36
 
37
37
  ## 安装
38
38
 
39
39
  ```bash
40
- pip install git-gcm
40
+ # Mac 用户先装 pipx
41
+ brew install pipx && pipx ensurepath
42
+
43
+ pipx install git-gcm
41
44
  ```
42
45
 
43
- ## 配置
46
+ 升级:`pipx upgrade git-gcm`
44
47
 
45
- 设置环境变量:
48
+ ## 配置
46
49
 
47
50
  ```bash
48
51
  export GCM_API_URL=https://api.openai.com/v1
@@ -50,33 +53,35 @@ export GCM_API_KEY=your-api-key
50
53
  export GCM_MODEL=gpt-4o-mini
51
54
  ```
52
55
 
56
+ 持久化写入 `~/.zshrc` / `~/.bashrc` 后 `source` 一下。
57
+
53
58
  ## 使用
54
59
 
55
60
  ```bash
56
61
  git add .
57
- gcm # 生成 commit message 并进入交互菜单
58
- gcm -v # 生成详细 commit message 并进入交互菜单
59
- gcm -f # 提交时跳过 git hooks(等价 git commit --no-verify)
60
- gcm --print-only # 仅输出 message,不提交(用于脚本/管道)
62
+ gcm # 生成 commit message 并进入交互菜单
63
+ gcm -v # 详细模式
64
+ gcm -f # 跳过 git hooks(等价 --no-verify)
65
+ gcm --print-only # 仅输出,不提交
61
66
  ```
62
67
 
63
- 运行 `gcm` 后会展示生成的 commit message,并用方向键导航的菜单让你选择:
68
+ 生成后进入交互菜单(↑↓ 选择,Enter 确认):
64
69
 
65
- - **提交此 message**:选中后按 Enter 直接执行 `git commit`
66
- - **修改 message**:在预填的编辑框里直接微调(支持多行,兼容 `-v`),Alt+Enter 提交后回到菜单
67
- - **仅输出,不提交**:只打印 message
70
+ - **提交** 直接 `git commit`
71
+ - **编辑** — 微调 messageAlt/⌥+Enter 保存
72
+ - **仅输出** — 只打印不提交
68
73
 
69
- > ↑↓ 移动选择,Enter 确认,ESC / Ctrl-C 取消。在管道或非交互终端(如 `gcm | cat`)中,gcm 会自动仅输出 message,不弹交互。
74
+ > 非交互终端(如 `gcm | cat`)自动跳过菜单,直接输出。
70
75
 
71
76
  ## 示例
72
77
 
73
- **精简模式:**
78
+ 精简模式:
74
79
 
75
80
  ```
76
81
  feat(auth): 添加用户登录功能
77
82
  ```
78
83
 
79
- **详细模式 (`-v`):**
84
+ 详细模式(`-v`):
80
85
 
81
86
  ```
82
87
  feat(auth): 添加用户登录功能
@@ -0,0 +1,64 @@
1
+ # GCM
2
+
3
+ [![PyPI version](https://badge.fury.io/py/git-gcm.svg)](https://pypi.org/project/git-gcm/)
4
+
5
+ 基于大模型的 Git Commit Message 生成,支持所有 OpenAI 协议兼容的服务。
6
+
7
+ ## 安装
8
+
9
+ ```bash
10
+ # Mac 用户先装 pipx
11
+ brew install pipx && pipx ensurepath
12
+
13
+ pipx install git-gcm
14
+ ```
15
+
16
+ 升级:`pipx upgrade git-gcm`
17
+
18
+ ## 配置
19
+
20
+ ```bash
21
+ export GCM_API_URL=https://api.openai.com/v1
22
+ export GCM_API_KEY=your-api-key
23
+ export GCM_MODEL=gpt-4o-mini
24
+ ```
25
+
26
+ 持久化写入 `~/.zshrc` / `~/.bashrc` 后 `source` 一下。
27
+
28
+ ## 使用
29
+
30
+ ```bash
31
+ git add .
32
+ gcm # 生成 commit message 并进入交互菜单
33
+ gcm -v # 详细模式
34
+ gcm -f # 跳过 git hooks(等价 --no-verify)
35
+ gcm --print-only # 仅输出,不提交
36
+ ```
37
+
38
+ 生成后进入交互菜单(↑↓ 选择,Enter 确认):
39
+
40
+ - **提交** — 直接 `git commit`
41
+ - **编辑** — 微调 message,Alt/⌥+Enter 保存
42
+ - **仅输出** — 只打印不提交
43
+
44
+ > 非交互终端(如 `gcm | cat`)自动跳过菜单,直接输出。
45
+
46
+ ## 示例
47
+
48
+ 精简模式:
49
+
50
+ ```
51
+ feat(auth): 添加用户登录功能
52
+ ```
53
+
54
+ 详细模式(`-v`):
55
+
56
+ ```
57
+ feat(auth): 添加用户登录功能
58
+
59
+ - 实现 JWT token 认证
60
+ - 添加登录表单验证
61
+ - 集成第三方 OAuth 登录
62
+ ```
63
+
64
+ MIT License
@@ -1,3 +1,3 @@
1
1
  """GCM - Git Commit Message Generator"""
2
2
 
3
- __version__ = "2.0.0"
3
+ __version__ = "2.0.1"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: git-gcm
3
- Version: 2.0.0
3
+ Version: 2.0.1
4
4
  Summary: Write Git commits the smart way.
5
5
  Author-email: Luca <yangshaoxiong5545@gmail.com>
6
6
  License: MIT
@@ -32,17 +32,20 @@ Dynamic: license-file
32
32
 
33
33
  [![PyPI version](https://badge.fury.io/py/git-gcm.svg)](https://pypi.org/project/git-gcm/)
34
34
 
35
- 基于大模型的 Git Commit Message 生成,支持所有 OpenAI 协议兼容的大模型服务
35
+ 基于大模型的 Git Commit Message 生成,支持所有 OpenAI 协议兼容的服务。
36
36
 
37
37
  ## 安装
38
38
 
39
39
  ```bash
40
- pip install git-gcm
40
+ # Mac 用户先装 pipx
41
+ brew install pipx && pipx ensurepath
42
+
43
+ pipx install git-gcm
41
44
  ```
42
45
 
43
- ## 配置
46
+ 升级:`pipx upgrade git-gcm`
44
47
 
45
- 设置环境变量:
48
+ ## 配置
46
49
 
47
50
  ```bash
48
51
  export GCM_API_URL=https://api.openai.com/v1
@@ -50,33 +53,35 @@ export GCM_API_KEY=your-api-key
50
53
  export GCM_MODEL=gpt-4o-mini
51
54
  ```
52
55
 
56
+ 持久化写入 `~/.zshrc` / `~/.bashrc` 后 `source` 一下。
57
+
53
58
  ## 使用
54
59
 
55
60
  ```bash
56
61
  git add .
57
- gcm # 生成 commit message 并进入交互菜单
58
- gcm -v # 生成详细 commit message 并进入交互菜单
59
- gcm -f # 提交时跳过 git hooks(等价 git commit --no-verify)
60
- gcm --print-only # 仅输出 message,不提交(用于脚本/管道)
62
+ gcm # 生成 commit message 并进入交互菜单
63
+ gcm -v # 详细模式
64
+ gcm -f # 跳过 git hooks(等价 --no-verify)
65
+ gcm --print-only # 仅输出,不提交
61
66
  ```
62
67
 
63
- 运行 `gcm` 后会展示生成的 commit message,并用方向键导航的菜单让你选择:
68
+ 生成后进入交互菜单(↑↓ 选择,Enter 确认):
64
69
 
65
- - **提交此 message**:选中后按 Enter 直接执行 `git commit`
66
- - **修改 message**:在预填的编辑框里直接微调(支持多行,兼容 `-v`),Alt+Enter 提交后回到菜单
67
- - **仅输出,不提交**:只打印 message
70
+ - **提交** 直接 `git commit`
71
+ - **编辑** — 微调 messageAlt/⌥+Enter 保存
72
+ - **仅输出** — 只打印不提交
68
73
 
69
- > ↑↓ 移动选择,Enter 确认,ESC / Ctrl-C 取消。在管道或非交互终端(如 `gcm | cat`)中,gcm 会自动仅输出 message,不弹交互。
74
+ > 非交互终端(如 `gcm | cat`)自动跳过菜单,直接输出。
70
75
 
71
76
  ## 示例
72
77
 
73
- **精简模式:**
78
+ 精简模式:
74
79
 
75
80
  ```
76
81
  feat(auth): 添加用户登录功能
77
82
  ```
78
83
 
79
- **详细模式 (`-v`):**
84
+ 详细模式(`-v`):
80
85
 
81
86
  ```
82
87
  feat(auth): 添加用户登录功能
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "git-gcm"
7
- version = "2.0.0"
7
+ version = "2.0.1"
8
8
  description = "Write Git commits the smart way."
9
9
  readme = "README.md"
10
10
  license = { text = "MIT" }
git_gcm-2.0.0/README.md DELETED
@@ -1,59 +0,0 @@
1
- # GCM
2
-
3
- [![PyPI version](https://badge.fury.io/py/git-gcm.svg)](https://pypi.org/project/git-gcm/)
4
-
5
- 基于大模型的 Git Commit Message 生成,支持所有 OpenAI 协议兼容的大模型服务
6
-
7
- ## 安装
8
-
9
- ```bash
10
- pip install git-gcm
11
- ```
12
-
13
- ## 配置
14
-
15
- 设置环境变量:
16
-
17
- ```bash
18
- export GCM_API_URL=https://api.openai.com/v1
19
- export GCM_API_KEY=your-api-key
20
- export GCM_MODEL=gpt-4o-mini
21
- ```
22
-
23
- ## 使用
24
-
25
- ```bash
26
- git add .
27
- gcm # 生成 commit message 并进入交互菜单
28
- gcm -v # 生成详细 commit message 并进入交互菜单
29
- gcm -f # 提交时跳过 git hooks(等价 git commit --no-verify)
30
- gcm --print-only # 仅输出 message,不提交(用于脚本/管道)
31
- ```
32
-
33
- 运行 `gcm` 后会展示生成的 commit message,并用方向键导航的菜单让你选择:
34
-
35
- - **提交此 message**:选中后按 Enter 直接执行 `git commit`
36
- - **修改 message**:在预填的编辑框里直接微调(支持多行,兼容 `-v`),Alt+Enter 提交后回到菜单
37
- - **仅输出,不提交**:只打印 message
38
-
39
- > ↑↓ 移动选择,Enter 确认,ESC / Ctrl-C 取消。在管道或非交互终端(如 `gcm | cat`)中,gcm 会自动仅输出 message,不弹交互。
40
-
41
- ## 示例
42
-
43
- **精简模式:**
44
-
45
- ```
46
- feat(auth): 添加用户登录功能
47
- ```
48
-
49
- **详细模式 (`-v`):**
50
-
51
- ```
52
- feat(auth): 添加用户登录功能
53
-
54
- - 实现 JWT token 认证
55
- - 添加登录表单验证
56
- - 集成第三方 OAuth 登录
57
- ```
58
-
59
- MIT License
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes