git-commit-msg-ai 1.4.1__tar.gz → 1.4.2__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.
Files changed (21) hide show
  1. {git_commit_msg_ai-1.4.1/git_commit_msg_ai.egg-info → git_commit_msg_ai-1.4.2}/PKG-INFO +35 -1
  2. git_commit_msg_ai-1.4.1/PKG-INFO → git_commit_msg_ai-1.4.2/README.md +99 -81
  3. git_commit_msg_ai-1.4.1/README.md → git_commit_msg_ai-1.4.2/git_commit_msg_ai.egg-info/PKG-INFO +115 -67
  4. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/git_commit_msg_ai.egg-info/requires.txt +2 -0
  5. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/pyproject.toml +2 -2
  6. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/git_commit_msg_ai/__init__.py +0 -0
  7. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/git_commit_msg_ai/ai_client.py +0 -0
  8. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/git_commit_msg_ai/cli.py +0 -0
  9. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/git_commit_msg_ai/editor.py +0 -0
  10. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/git_commit_msg_ai/exceptions.py +0 -0
  11. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/git_commit_msg_ai/git_ops.py +0 -0
  12. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/git_commit_msg_ai.egg-info/SOURCES.txt +0 -0
  13. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/git_commit_msg_ai.egg-info/dependency_links.txt +0 -0
  14. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/git_commit_msg_ai.egg-info/entry_points.txt +0 -0
  15. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/git_commit_msg_ai.egg-info/top_level.txt +0 -0
  16. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/setup.cfg +0 -0
  17. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/tests/test_ai_client.py +0 -0
  18. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/tests/test_cli.py +0 -0
  19. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/tests/test_editor.py +0 -0
  20. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/tests/test_exceptions.py +0 -0
  21. {git_commit_msg_ai-1.4.1 → git_commit_msg_ai-1.4.2}/tests/test_git_ops.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: git-commit-msg-ai
3
- Version: 1.4.1
3
+ Version: 1.4.2
4
4
  Summary: AI-powered git commit message generator following Conventional Commits
5
5
  License-Expression: MIT
6
6
  Requires-Python: >=3.10
@@ -11,6 +11,8 @@ Requires-Dist: mypy; extra == "dev"
11
11
  Requires-Dist: ruff; extra == "dev"
12
12
  Requires-Dist: pytest; extra == "dev"
13
13
  Requires-Dist: pytest-cov; extra == "dev"
14
+ Requires-Dist: build; extra == "dev"
15
+ Requires-Dist: twine; extra == "dev"
14
16
 
15
17
  # git-commit-msg-ai
16
18
 
@@ -29,6 +31,38 @@ AI-powered git commit message generator that follows the [Conventional Commits](
29
31
  [System.Environment]::SetEnvironmentVariable('ANTHROPIC_API_KEY', 'sk-ant-...', 'User') # Windows
30
32
  ```
31
33
 
34
+ ## Development Setup
35
+
36
+ Clone the repository, create a virtual environment, and install the project in editable mode with all dev dependencies:
37
+
38
+ ```sh
39
+ python -m venv .venv
40
+ ```
41
+
42
+ Activate the virtual environment:
43
+
44
+ ```sh
45
+ # macOS/Linux
46
+ source .venv/bin/activate
47
+
48
+ # Windows PowerShell
49
+ .venv\Scripts\Activate.ps1
50
+ ```
51
+
52
+ Install the project and dev dependencies:
53
+
54
+ ```sh
55
+ pip install -e ".[dev]"
56
+ ```
57
+
58
+ After activation the `git-commit-msg-ai` entry-point is on your PATH. You can also run the dev toolchain:
59
+
60
+ ```sh
61
+ pytest # run tests with coverage
62
+ ruff check . # lint
63
+ mypy . # type-check
64
+ ```
65
+
32
66
  ## Installation
33
67
 
34
68
  ```sh
@@ -1,81 +1,99 @@
1
- Metadata-Version: 2.4
2
- Name: git-commit-msg-ai
3
- Version: 1.4.1
4
- Summary: AI-powered git commit message generator following Conventional Commits
5
- License-Expression: MIT
6
- Requires-Python: >=3.10
7
- Description-Content-Type: text/markdown
8
- Requires-Dist: anthropic
9
- Provides-Extra: dev
10
- Requires-Dist: mypy; extra == "dev"
11
- Requires-Dist: ruff; extra == "dev"
12
- Requires-Dist: pytest; extra == "dev"
13
- Requires-Dist: pytest-cov; extra == "dev"
14
-
15
- # git-commit-msg-ai
16
-
17
- AI-powered git commit message generator that follows the [Conventional Commits](https://www.conventionalcommits.org/) specification.
18
-
19
- ## Prerequisites
20
-
21
- - Python 3.10+
22
- - An Anthropic API key set as an environment variable:
23
-
24
- ```sh
25
- export ANTHROPIC_API_KEY=sk-ant-... # macOS/Linux
26
- ```
27
-
28
- ```powershell
29
- [System.Environment]::SetEnvironmentVariable('ANTHROPIC_API_KEY', 'sk-ant-...', 'User') # Windows
30
- ```
31
-
32
- ## Installation
33
-
34
- ```sh
35
- pip install git-commit-msg-ai
36
- ```
37
-
38
- ## Usage
39
-
40
- Stage your changes, then run the tool from inside any git repository:
41
-
42
- ```sh
43
- git add <files>
44
- git-commit-msg-ai
45
- ```
46
-
47
- The tool will:
48
- 1. Read your staged diff
49
- 2. Generate a commit message using Claude AI
50
- 3. Print the message and prompt you to choose:
51
-
52
- ```
53
- [a]ccept / [e]dit / [r]eject:
54
- ```
55
-
56
- - **a** - commits immediately with the generated message
57
- - **e** - opens the message in your `$EDITOR` (defaults to `notepad` on Windows, `vi` on Linux/macOS), lets you modify it, then commits
58
- - **r** - exits without committing
59
-
60
- ## Commit message format
61
-
62
- Generated messages follow the Conventional Commits specification:
63
-
64
- ```
65
- <type>(<optional scope>): <short subject>
66
-
67
- - Bullet explaining why this change was made
68
- - Another reason if applicable
69
- ```
70
-
71
- For breaking changes, the subject line gets a `!` and a footer is added:
72
-
73
- ```
74
- feat(api)!: remove deprecated endpoint
75
-
76
- - Endpoint was unused and blocking the new auth rollout
77
-
78
- BREAKING CHANGE: /v1/legacy is no longer available
79
- ```
80
-
81
- Supported types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
1
+ # git-commit-msg-ai
2
+
3
+ AI-powered git commit message generator that follows the [Conventional Commits](https://www.conventionalcommits.org/) specification.
4
+
5
+ ## Prerequisites
6
+
7
+ - Python 3.10+
8
+ - An Anthropic API key set as an environment variable:
9
+
10
+ ```sh
11
+ export ANTHROPIC_API_KEY=sk-ant-... # macOS/Linux
12
+ ```
13
+
14
+ ```powershell
15
+ [System.Environment]::SetEnvironmentVariable('ANTHROPIC_API_KEY', 'sk-ant-...', 'User') # Windows
16
+ ```
17
+
18
+ ## Development Setup
19
+
20
+ Clone the repository, create a virtual environment, and install the project in editable mode with all dev dependencies:
21
+
22
+ ```sh
23
+ python -m venv .venv
24
+ ```
25
+
26
+ Activate the virtual environment:
27
+
28
+ ```sh
29
+ # macOS/Linux
30
+ source .venv/bin/activate
31
+
32
+ # Windows PowerShell
33
+ .venv\Scripts\Activate.ps1
34
+ ```
35
+
36
+ Install the project and dev dependencies:
37
+
38
+ ```sh
39
+ pip install -e ".[dev]"
40
+ ```
41
+
42
+ After activation the `git-commit-msg-ai` entry-point is on your PATH. You can also run the dev toolchain:
43
+
44
+ ```sh
45
+ pytest # run tests with coverage
46
+ ruff check . # lint
47
+ mypy . # type-check
48
+ ```
49
+
50
+ ## Installation
51
+
52
+ ```sh
53
+ pip install git-commit-msg-ai
54
+ ```
55
+
56
+ ## Usage
57
+
58
+ Stage your changes, then run the tool from inside any git repository:
59
+
60
+ ```sh
61
+ git add <files>
62
+ git-commit-msg-ai
63
+ ```
64
+
65
+ The tool will:
66
+ 1. Read your staged diff
67
+ 2. Generate a commit message using Claude AI
68
+ 3. Print the message and prompt you to choose:
69
+
70
+ ```
71
+ [a]ccept / [e]dit / [r]eject:
72
+ ```
73
+
74
+ - **a** - commits immediately with the generated message
75
+ - **e** - opens the message in your `$EDITOR` (defaults to `notepad` on Windows, `vi` on Linux/macOS), lets you modify it, then commits
76
+ - **r** - exits without committing
77
+
78
+ ## Commit message format
79
+
80
+ Generated messages follow the Conventional Commits specification:
81
+
82
+ ```
83
+ <type>(<optional scope>): <short subject>
84
+
85
+ - Bullet explaining why this change was made
86
+ - Another reason if applicable
87
+ ```
88
+
89
+ For breaking changes, the subject line gets a `!` and a footer is added:
90
+
91
+ ```
92
+ feat(api)!: remove deprecated endpoint
93
+
94
+ - Endpoint was unused and blocking the new auth rollout
95
+
96
+ BREAKING CHANGE: /v1/legacy is no longer available
97
+ ```
98
+
99
+ Supported types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
@@ -1,67 +1,115 @@
1
- # git-commit-msg-ai
2
-
3
- AI-powered git commit message generator that follows the [Conventional Commits](https://www.conventionalcommits.org/) specification.
4
-
5
- ## Prerequisites
6
-
7
- - Python 3.10+
8
- - An Anthropic API key set as an environment variable:
9
-
10
- ```sh
11
- export ANTHROPIC_API_KEY=sk-ant-... # macOS/Linux
12
- ```
13
-
14
- ```powershell
15
- [System.Environment]::SetEnvironmentVariable('ANTHROPIC_API_KEY', 'sk-ant-...', 'User') # Windows
16
- ```
17
-
18
- ## Installation
19
-
20
- ```sh
21
- pip install git-commit-msg-ai
22
- ```
23
-
24
- ## Usage
25
-
26
- Stage your changes, then run the tool from inside any git repository:
27
-
28
- ```sh
29
- git add <files>
30
- git-commit-msg-ai
31
- ```
32
-
33
- The tool will:
34
- 1. Read your staged diff
35
- 2. Generate a commit message using Claude AI
36
- 3. Print the message and prompt you to choose:
37
-
38
- ```
39
- [a]ccept / [e]dit / [r]eject:
40
- ```
41
-
42
- - **a** - commits immediately with the generated message
43
- - **e** - opens the message in your `$EDITOR` (defaults to `notepad` on Windows, `vi` on Linux/macOS), lets you modify it, then commits
44
- - **r** - exits without committing
45
-
46
- ## Commit message format
47
-
48
- Generated messages follow the Conventional Commits specification:
49
-
50
- ```
51
- <type>(<optional scope>): <short subject>
52
-
53
- - Bullet explaining why this change was made
54
- - Another reason if applicable
55
- ```
56
-
57
- For breaking changes, the subject line gets a `!` and a footer is added:
58
-
59
- ```
60
- feat(api)!: remove deprecated endpoint
61
-
62
- - Endpoint was unused and blocking the new auth rollout
63
-
64
- BREAKING CHANGE: /v1/legacy is no longer available
65
- ```
66
-
67
- Supported types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
1
+ Metadata-Version: 2.4
2
+ Name: git-commit-msg-ai
3
+ Version: 1.4.2
4
+ Summary: AI-powered git commit message generator following Conventional Commits
5
+ License-Expression: MIT
6
+ Requires-Python: >=3.10
7
+ Description-Content-Type: text/markdown
8
+ Requires-Dist: anthropic
9
+ Provides-Extra: dev
10
+ Requires-Dist: mypy; extra == "dev"
11
+ Requires-Dist: ruff; extra == "dev"
12
+ Requires-Dist: pytest; extra == "dev"
13
+ Requires-Dist: pytest-cov; extra == "dev"
14
+ Requires-Dist: build; extra == "dev"
15
+ Requires-Dist: twine; extra == "dev"
16
+
17
+ # git-commit-msg-ai
18
+
19
+ AI-powered git commit message generator that follows the [Conventional Commits](https://www.conventionalcommits.org/) specification.
20
+
21
+ ## Prerequisites
22
+
23
+ - Python 3.10+
24
+ - An Anthropic API key set as an environment variable:
25
+
26
+ ```sh
27
+ export ANTHROPIC_API_KEY=sk-ant-... # macOS/Linux
28
+ ```
29
+
30
+ ```powershell
31
+ [System.Environment]::SetEnvironmentVariable('ANTHROPIC_API_KEY', 'sk-ant-...', 'User') # Windows
32
+ ```
33
+
34
+ ## Development Setup
35
+
36
+ Clone the repository, create a virtual environment, and install the project in editable mode with all dev dependencies:
37
+
38
+ ```sh
39
+ python -m venv .venv
40
+ ```
41
+
42
+ Activate the virtual environment:
43
+
44
+ ```sh
45
+ # macOS/Linux
46
+ source .venv/bin/activate
47
+
48
+ # Windows PowerShell
49
+ .venv\Scripts\Activate.ps1
50
+ ```
51
+
52
+ Install the project and dev dependencies:
53
+
54
+ ```sh
55
+ pip install -e ".[dev]"
56
+ ```
57
+
58
+ After activation the `git-commit-msg-ai` entry-point is on your PATH. You can also run the dev toolchain:
59
+
60
+ ```sh
61
+ pytest # run tests with coverage
62
+ ruff check . # lint
63
+ mypy . # type-check
64
+ ```
65
+
66
+ ## Installation
67
+
68
+ ```sh
69
+ pip install git-commit-msg-ai
70
+ ```
71
+
72
+ ## Usage
73
+
74
+ Stage your changes, then run the tool from inside any git repository:
75
+
76
+ ```sh
77
+ git add <files>
78
+ git-commit-msg-ai
79
+ ```
80
+
81
+ The tool will:
82
+ 1. Read your staged diff
83
+ 2. Generate a commit message using Claude AI
84
+ 3. Print the message and prompt you to choose:
85
+
86
+ ```
87
+ [a]ccept / [e]dit / [r]eject:
88
+ ```
89
+
90
+ - **a** - commits immediately with the generated message
91
+ - **e** - opens the message in your `$EDITOR` (defaults to `notepad` on Windows, `vi` on Linux/macOS), lets you modify it, then commits
92
+ - **r** - exits without committing
93
+
94
+ ## Commit message format
95
+
96
+ Generated messages follow the Conventional Commits specification:
97
+
98
+ ```
99
+ <type>(<optional scope>): <short subject>
100
+
101
+ - Bullet explaining why this change was made
102
+ - Another reason if applicable
103
+ ```
104
+
105
+ For breaking changes, the subject line gets a `!` and a footer is added:
106
+
107
+ ```
108
+ feat(api)!: remove deprecated endpoint
109
+
110
+ - Endpoint was unused and blocking the new auth rollout
111
+
112
+ BREAKING CHANGE: /v1/legacy is no longer available
113
+ ```
114
+
115
+ Supported types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
@@ -5,3 +5,5 @@ mypy
5
5
  ruff
6
6
  pytest
7
7
  pytest-cov
8
+ build
9
+ twine
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "git-commit-msg-ai"
7
- version = "1.4.1"
7
+ version = "1.4.2"
8
8
  description = "AI-powered git commit message generator following Conventional Commits"
9
9
  readme = "README.md"
10
10
  license = "MIT"
@@ -15,7 +15,7 @@ dependencies = ["anthropic"]
15
15
  git-commit-msg-ai = "git_commit_msg_ai.cli:main"
16
16
 
17
17
  [project.optional-dependencies]
18
- dev = ["mypy", "ruff", "pytest", "pytest-cov"]
18
+ dev = ["mypy", "ruff", "pytest", "pytest-cov", "build", "twine"]
19
19
 
20
20
  [tool.ruff]
21
21
  target-version = "py310"