git-commit-msg-ai 1.4.2__py3-none-any.whl → 1.5.0__py3-none-any.whl

git_commit_msg_ai/ai_client.py

@@ -1,3 +1,4 @@
+import logging
 import textwrap
 from typing import Final, cast
 
@@ -5,6 +6,8 @@ import anthropic
 
 from git_commit_msg_ai.exceptions import AIError
 
+logger = logging.getLogger(__name__)
+
 SYSTEM_PROMPT: Final[str] = textwrap.dedent("""\
     You are a Git commit message generator. Output only the commit message, nothing else. Follow the Conventional Commits specification:
     - First line: <type>(<optional scope>)<!>: <short subject> (50 chars max); append ! before the colon if the commit introduces a breaking change
@@ -21,6 +24,7 @@ def generate_commit_message(diff: str) -> str:
     try:
         anthropic_client = anthropic.Anthropic()
 
+        logger.debug('Calling Anthropic API: model=%s max_tokens=%d', MODEL, MAX_TOKENS)
         anthropic_api_response = anthropic_client.messages.create(
             model=MODEL,
             max_tokens=MAX_TOKENS,
@@ -28,15 +32,21 @@ def generate_commit_message(diff: str) -> str:
             messages=[{'role': 'user', 'content': diff}],
         )
     except anthropic.AuthenticationError:
+        logger.error('Anthropic authentication error')
         raise AIError('Anthropic API key is missing or invalid. Set the ANTHROPIC_API_KEY environment variable.')
     except anthropic.RateLimitError:
+        logger.error('Anthropic rate limit error')
         raise AIError('Anthropic API rate limit reached. Wait a moment and try again.')
     except anthropic.APIConnectionError:
+        logger.error('Anthropic API connection error')
         raise AIError('Could not reach the Anthropic API. Check your network connection.')
     except anthropic.APIStatusError as error:
+        logger.error('Anthropic API status error: %s', error.status_code)
         raise AIError(f'Anthropic API returned an error: {error.status_code}.')
 
     anthropic_api_response_message = anthropic_api_response.content[0]
     commit_message = cast(anthropic.types.TextBlock, anthropic_api_response_message).text.strip()
 
+    logger.info('Commit message generated: %d chars', len(commit_message))
+
     return commit_message

git_commit_msg_ai/cli.py

@@ -1,10 +1,26 @@
+import logging
+import os
 import sys
+from typing import Final
 
 from git_commit_msg_ai import ai_client, editor, git_ops
 from git_commit_msg_ai.exceptions import GitCommitAIError
 
+LOG_LEVEL_ENV_VAR: Final[str] = 'GIT_COMMIT_AI_LOG_LEVEL'
+
 
 def main() -> None:
+    log_level_name = os.environ.get(LOG_LEVEL_ENV_VAR, 'WARNING').upper()
+    numeric_log_level = getattr(logging, log_level_name, None)
+
+    if not isinstance(numeric_log_level, int):
+        numeric_log_level = logging.WARNING
+
+    logging.basicConfig(level=numeric_log_level, format='%(levelname)s:%(name)s:%(message)s', stream=sys.stderr)
+
+    if not isinstance(getattr(logging, log_level_name, None), int):
+        logging.warning('Invalid %s value %r, defaulting to WARNING', LOG_LEVEL_ENV_VAR, log_level_name)
+
     try:
         diff = git_ops.get_staged_diff()
         commit_message = ai_client.generate_commit_message(diff)

git_commit_msg_ai/editor.py

@@ -1,3 +1,4 @@
+import logging
 import os
 import platform
 import subprocess
@@ -5,6 +6,8 @@ import tempfile
 
 from git_commit_msg_ai.exceptions import EditorError
 
+logger = logging.getLogger(__name__)
+
 
 def get_default_editor() -> str:
     current_platform = platform.system()
@@ -19,25 +22,38 @@ def open_in_editor(initial_text: str) -> str:
             temp_file.write(initial_text)
             temp_file_path = temp_file.name
     except OSError:
+        logger.error('Could not create temporary file')
         raise EditorError('Could not create a temporary file.')
 
+    logger.debug('Temporary file created: %s', temp_file_path)
+
     platform_default_editor = get_default_editor()
     editor_command = os.environ.get('EDITOR', platform_default_editor)
 
+    logger.debug('Selected editor: %s', editor_command)
+
     try:
         try:
+            logger.debug('Opening editor: %s %s', editor_command, temp_file_path)
             subprocess.run([editor_command, temp_file_path], check=True)
         except FileNotFoundError:
+            logger.error('Editor not found: %s', editor_command)
             raise EditorError(f'Editor "{editor_command}" was not found. Set the EDITOR environment variable to a valid editor.')
         except subprocess.CalledProcessError:
+            logger.error('Editor exited with error: %s', editor_command)
             raise EditorError(f'Editor "{editor_command}" exited with an error.')
 
+        logger.debug('Editor closed, reading edited content')
+
         try:
             with open(temp_file_path) as temp_file:
                 edited_text = temp_file.read().strip()
         except OSError:
+            logger.error('Could not read temporary file: %s', temp_file_path)
             raise EditorError('Could not read the edited commit message from the temporary file.')
     finally:
         os.unlink(temp_file_path)
 
+    logger.debug('Edited text read: %d chars', len(edited_text))
+
     return edited_text

git_commit_msg_ai/git_ops.py

@@ -1,3 +1,4 @@
+import logging
 import subprocess
 from typing import Final
 
@@ -10,18 +11,28 @@ COMMIT_SUBCOMMAND: Final[str] = 'commit'
 MESSAGE_FLAG: Final[str] = '-m'
 UTF8_ENCODING: Final[str] = 'utf-8'
 
+logger = logging.getLogger(__name__)
+
 
 def get_staged_diff() -> str:
     try:
-        staged_diff = subprocess.check_output([GIT_COMMAND, DIFF_SUBCOMMAND, CACHED_FLAG]).decode(UTF8_ENCODING)
+        logger.debug('Running: %s %s %s', GIT_COMMAND, DIFF_SUBCOMMAND, CACHED_FLAG)
+        raw_diff_bytes = subprocess.check_output([GIT_COMMAND, DIFF_SUBCOMMAND, CACHED_FLAG])
+        staged_diff = raw_diff_bytes.decode(UTF8_ENCODING)
     except FileNotFoundError:
+        logger.error('git not found on PATH')
         raise GitError('git is not installed or not on PATH.')
     except subprocess.CalledProcessError:
+        logger.error('git diff --cached exited non-zero')
         raise GitError('Failed to get staged diff. Are you inside a git repository?')
     except UnicodeDecodeError:
+        logger.error('Staged diff could not be decoded as UTF-8')
         raise GitError('Staged diff contains bytes that could not be decoded as UTF-8.')
 
+    logger.debug('Staged diff received: %d chars', len(staged_diff))
+
     if not staged_diff:
+        logger.warning('No staged changes found')
         raise GitError('No staged changes found. Stage files with git add before running.')
 
     return staged_diff
@@ -29,8 +40,13 @@ def get_staged_diff() -> str:
 
 def commit(message: str) -> None:
     try:
+        logger.debug('Running: %s %s %s <message>', GIT_COMMAND, COMMIT_SUBCOMMAND, MESSAGE_FLAG)
         subprocess.run([GIT_COMMAND, COMMIT_SUBCOMMAND, MESSAGE_FLAG, message], check=True)
     except FileNotFoundError:
+        logger.error('git not found on PATH')
         raise GitError('git is not installed or not on PATH.')
     except subprocess.CalledProcessError:
+        logger.error('git commit exited non-zero')
         raise GitError('git commit failed.')
+
+    logger.info('Commit created successfully')

{git_commit_msg_ai-1.4.2.dist-info → git_commit_msg_ai-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-msg-ai
-Version: 1.4.2
+Version: 1.5.0
 Summary: AI-powered git commit message generator following Conventional Commits
 License-Expression: MIT
 Requires-Python: >=3.10
@@ -113,3 +113,25 @@ BREAKING CHANGE: /v1/legacy is no longer available
 ```
 
 Supported types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
+
+## Debugging
+
+By default the tool produces no diagnostic output. To enable logging, set the `GIT_COMMIT_AI_LOG_LEVEL` environment variable before running the command. Logs are written to **stderr** and do not interfere with the generated commit message on **stdout**.
+
+Valid values: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`
+
+```sh
+# macOS/Linux - show all internal diagnostic messages
+GIT_COMMIT_AI_LOG_LEVEL=DEBUG git-commit-msg-ai
+
+# Windows PowerShell
+$env:GIT_COMMIT_AI_LOG_LEVEL = 'DEBUG'
+git-commit-msg-ai
+```
+
+| Level | What you see |
+|---|---|
+| `DEBUG` | git commands run, API model/token params, temp file paths, char counts |
+| `INFO` | commit message generated, commit created |
+| `WARNING` | no staged changes found |
+| `ERROR` | git not found, API failures, editor errors |

git_commit_msg_ai-1.5.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+git_commit_msg_ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+git_commit_msg_ai/ai_client.py,sha256=JGqdTFJpuSlb3RjLoZwbEV6iGYDX9UxtaBkx0JO7y8U,2340
+git_commit_msg_ai/cli.py,sha256=QufaGlgPmiUbQpLmHcztnAczyzGnK6tqMG6yBH0V3rE,1686
+git_commit_msg_ai/editor.py,sha256=KErbsRLuWGsthx61irVr7skrpdup-hlkmE12BfJZOaU,2087
+git_commit_msg_ai/exceptions.py,sha256=7Hwluf3zHMjs4lpGktWS-Lwgo8y_4Xbb1WqzPQHkkUA,352
+git_commit_msg_ai/git_ops.py,sha256=ZBF-J2M6bMb2K_thrjWSHPSR4cjH9y2rK5rTiDm4CvY,1974
+git_commit_msg_ai-1.5.0.dist-info/METADATA,sha256=RFp4v7K4Wm2-FWXKC_YaFEuGQl3orx5rnBUN2gB1RYY,3586
+git_commit_msg_ai-1.5.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+git_commit_msg_ai-1.5.0.dist-info/entry_points.txt,sha256=KTu6wUhl0p3nf27k8L4vpSH_hpeRQpwzMPSmKv7K5Cs,65
+git_commit_msg_ai-1.5.0.dist-info/top_level.txt,sha256=XYQC2BXvrcREGKEG7sm9nbwO7ifqcUSVgU7SW8BTURs,18
+git_commit_msg_ai-1.5.0.dist-info/RECORD,,

git_commit_msg_ai-1.4.2.dist-info/RECORD

@@ -1,11 +0,0 @@
-git_commit_msg_ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-git_commit_msg_ai/ai_client.py,sha256=RnzgIx1ieuiiH6w2VijA6_F-cs6tIQR57W1x3avg8lE,1887
-git_commit_msg_ai/cli.py,sha256=s94orvxin-38vqUYWAO-j5_JZTzxBXbZSVOHYZ5KO_k,1059
-git_commit_msg_ai/editor.py,sha256=JnVm5SZwkunyfOjisDKvTuPm3_NPbijVk_ho_yQy-3o,1430
-git_commit_msg_ai/exceptions.py,sha256=7Hwluf3zHMjs4lpGktWS-Lwgo8y_4Xbb1WqzPQHkkUA,352
-git_commit_msg_ai/git_ops.py,sha256=k2kjwcvj0Ac-WAttSsMP8pIl4-WXUKK47thgjaB62Og,1263
-git_commit_msg_ai-1.4.2.dist-info/METADATA,sha256=BzSJx7Vdzjo9CrRi2-88_HvbR1aQjJnci2deJQvtthQ,2768
-git_commit_msg_ai-1.4.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-git_commit_msg_ai-1.4.2.dist-info/entry_points.txt,sha256=KTu6wUhl0p3nf27k8L4vpSH_hpeRQpwzMPSmKv7K5Cs,65
-git_commit_msg_ai-1.4.2.dist-info/top_level.txt,sha256=XYQC2BXvrcREGKEG7sm9nbwO7ifqcUSVgU7SW8BTURs,18
-git_commit_msg_ai-1.4.2.dist-info/RECORD,,