git-spellcheck 0.1.0__tar.gz

git_spellcheck-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Asad Khalid
+
+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_spellcheck-0.1.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: git-spellcheck
+Version: 0.1.0
+Summary: Interactive Git commit message spellchecker
+Home-page: https://github.com/Asad-K2025/git-spellcheck
+Author: Asad Khalid
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyspellchecker>=0.7.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Git Spellcheck
+
+Spelling mistakes in commit messages can easily occur, especially when using the CLI with `git commit -m`.  
+
+This tool aims to be quick and easy to set up, while also being lightweight. It automatically checks for spelling errors
+in commit message and provides an option to interactively fix them without rewriting the entire message.
+## How To Use
+
+1. Install from PyPi: 
+    ```bash
+    pip install git-spellcheck
+    ```
+2. Either setup:
+
+    **Global installation** for all repositories:
+    
+    ```bash
+    git-spellcheck --install-global
+    ```
+    
+    OR **local installation** only for current repository
+    ```bash
+    git-spellcheck --install-local
+    ```
+
+3. Commit as usual 
+    ```bash
+   git commit -m "Fix autentcation bug in login modul"
+   ```
+   If spelling mistakes are found, you'll see:
+    ```
+    Git Spellcheck Warning:
+    - "autentcation" (suggestions: authentication)
+    - "modul" (suggestions: module, moduli, model, mosul, mogul, modal)
+   Run `git-spellcheck --fix` to amend.```
+   
+4. Fix last commit interactively
+    ```bash
+    git-spellcheck --fix
+   ```
+   Interactive mode lets you:
+   - See spelling suggestions 
+   - Enter replacements 
+   - Automatically amend your last commit
+   
+   ```
+       - "autentcation"
+       suggestions: authentication
+       Enter replacement (or press ENTER to skip):
+    ```
+5. The commit is now ready to be pushed.
+   
+
+## Behavior
+
+When a commit is made, the subject line is scanned for misspelled words using `pyspellchecker`. If issues are found, suggestions are displayed.
+
+The interactive mode allows reviewing each misspelled word and optionally replacing it, automatically amending the last commit with the corrected message.
+
+Adding `[skip-spell]` to a commit message bypasses the spellcheck. The flag is automatically removed before finalising 
+the commit.
+
+## Requirements
+
+- Python 3.7 or higher  
+- Git

git_spellcheck-0.1.0/README.md

@@ -0,0 +1,66 @@
+# Git Spellcheck
+
+Spelling mistakes in commit messages can easily occur, especially when using the CLI with `git commit -m`.  
+
+This tool aims to be quick and easy to set up, while also being lightweight. It automatically checks for spelling errors
+in commit message and provides an option to interactively fix them without rewriting the entire message.
+## How To Use
+
+1. Install from PyPi: 
+    ```bash
+    pip install git-spellcheck
+    ```
+2. Either setup:
+
+    **Global installation** for all repositories:
+    
+    ```bash
+    git-spellcheck --install-global
+    ```
+    
+    OR **local installation** only for current repository
+    ```bash
+    git-spellcheck --install-local
+    ```
+
+3. Commit as usual 
+    ```bash
+   git commit -m "Fix autentcation bug in login modul"
+   ```
+   If spelling mistakes are found, you'll see:
+    ```
+    Git Spellcheck Warning:
+    - "autentcation" (suggestions: authentication)
+    - "modul" (suggestions: module, moduli, model, mosul, mogul, modal)
+   Run `git-spellcheck --fix` to amend.```
+   
+4. Fix last commit interactively
+    ```bash
+    git-spellcheck --fix
+   ```
+   Interactive mode lets you:
+   - See spelling suggestions 
+   - Enter replacements 
+   - Automatically amend your last commit
+   
+   ```
+       - "autentcation"
+       suggestions: authentication
+       Enter replacement (or press ENTER to skip):
+    ```
+5. The commit is now ready to be pushed.
+   
+
+## Behavior
+
+When a commit is made, the subject line is scanned for misspelled words using `pyspellchecker`. If issues are found, suggestions are displayed.
+
+The interactive mode allows reviewing each misspelled word and optionally replacing it, automatically amending the last commit with the corrected message.
+
+Adding `[skip-spell]` to a commit message bypasses the spellcheck. The flag is automatically removed before finalising 
+the commit.
+
+## Requirements
+
+- Python 3.7 or higher  
+- Git

git_spellcheck-0.1.0/git_spellcheck/cli.py

@@ -0,0 +1,168 @@
+#!/usr/bin/env python3
+import sys
+import re
+import platform
+import subprocess
+import os
+from pathlib import Path
+from spellchecker import SpellChecker
+
+BYPASS_FLAG = "[skip-spell]"
+
+
+def run_commit_msg_hook(commit_msg_file: str):
+    spell = SpellChecker()
+    commit_msg_path = Path(commit_msg_file)
+
+    message = commit_msg_path.read_text(encoding="utf-8")
+
+    if BYPASS_FLAG in message:
+        cleaned = message.replace(BYPASS_FLAG, "").strip()
+        commit_msg_path.write_text(cleaned, encoding="utf-8")
+        return 0
+
+    subject = message.split("\n")[0]
+    words = re.findall(r"\b[a-zA-Z']+\b", subject)
+    misspelled = list(spell.unknown(words))
+
+    if not misspelled:
+        return 0
+
+    print("\nGit Spellcheck Warning:")
+    for word in misspelled:
+        candidates = spell.candidates(word)
+        suggestions = list(candidates)[:6] if candidates else []
+        if suggestions:
+            print(f'  - "{word}" (suggestions: {", ".join(suggestions)})')
+        else:
+            print(f'  - "{word}" has no suggestions')
+
+    print("Run `git-spellcheck --fix` to amend.\n")
+
+    return 0
+
+
+def fix_last_commit():
+    spell = SpellChecker()
+
+    result = subprocess.run(
+        ["git", "log", "-1", "--pretty=%B"],
+        capture_output=True,
+        text=True
+    )
+
+    print("""---------------------------------
+Git Spellcheck - Interactive Mode
+---------------------------------""")
+    print()
+
+    if result.returncode != 0:
+        print("Failed to retrieve last commit message. Exiting Git Spellcheck.")
+        return 1
+
+    message = result.stdout
+    lines = message.split("\n")
+    subject = lines[0]
+
+    words = re.findall(r"\b[a-zA-Z']+\b", subject)
+    misspelled = list(spell.unknown(words))
+
+    if not misspelled:
+        print("No spelling issues found. Exiting Git Spellcheck.")
+        return 0
+
+    updated_subject = subject
+
+    for word in misspelled:
+        print("-" * 20)
+        print(f'  - "{word}"')
+        candidates = spell.candidates(word)
+        suggestions = list(candidates)[:6] if candidates else []
+
+        if suggestions:
+            print(f"    suggestions: {', '.join(suggestions)}")
+        else:
+            print("    no suggestions")
+
+        replacement = input("Enter replacement (or press ENTER to skip): ").strip()
+        print("-" * 20)
+        print()
+
+        if replacement:
+            def replace_match(match):
+                original = match.group(0)
+
+                if original.isupper():
+                    return replacement.upper()
+                elif original[0].isupper():
+                    return replacement.capitalize()
+                else:
+                    return replacement
+
+            updated_subject = re.sub(
+                rf"\b{re.escape(word)}\b",
+                replace_match,
+                updated_subject,
+                flags=re.IGNORECASE
+            )
+
+    if updated_subject == subject:
+        print("No changes made.")
+        return 0
+
+    lines[0] = updated_subject
+    new_message = "\n".join(lines)
+
+    subprocess.run(["git", "commit", "--amend", "-m", new_message])
+    return 0
+
+
+def install_hook(global_install=False):
+    if platform.system() == "Windows":
+        hooks_path = Path(os.environ["USERPROFILE"]) / ".git-hooks"
+    else:
+        hooks_path = Path.home() / ".git-hooks"
+
+    if global_install:
+        hooks_path.mkdir(exist_ok=True)
+        hook_file = hooks_path / "commit-msg"
+        hook_file.write_text("""#!/bin/sh
+git-spellcheck "$1"
+""")
+        hook_file.chmod(0o755)
+        subprocess.run(["git", "config", "--global", "core.hooksPath", str(hooks_path)])
+        print(f"Global commit-msg hook installed in {hooks_path}")
+    else:
+        repo_hooks = Path(".git/hooks")
+        if not repo_hooks.exists():
+            print("Not a git repository.")
+            return
+        repo_hooks.mkdir(exist_ok=True)
+        hook_file = repo_hooks / "commit-msg"
+        hook_file.write_text("""#!/bin/sh
+git-spellcheck "$1"
+""")
+        hook_file.chmod(0o755)
+        print(f"commit-msg hook installed in {repo_hooks}")
+
+
+def main():
+    import argparse
+    parser = argparse.ArgumentParser(description="Interactive Git commit message spellchecker")
+    parser.add_argument("commit_msg_file", nargs="?", help=argparse.SUPPRESS)
+    parser.add_argument("--install-global", action="store_true", help="Install commit-msg hook globally")
+    parser.add_argument("--install-local", action="store_true", help="Install commit-msg hook locally in current repo")
+    parser.add_argument("--fix", action="store_true", help="Interactively fix last commit")
+    args = parser.parse_args()
+
+    if args.install_global:
+        install_hook(global_install=True)
+    elif args.install_local:
+        install_hook(global_install=False)
+    elif args.commit_msg_file:
+        sys.exit(run_commit_msg_hook(args.commit_msg_file))
+    elif args.fix:
+        sys.exit(fix_last_commit())
+    else:
+        parser.print_help()
+        sys.exit(1)

git_spellcheck-0.1.0/git_spellcheck.egg-info/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: git-spellcheck
+Version: 0.1.0
+Summary: Interactive Git commit message spellchecker
+Home-page: https://github.com/Asad-K2025/git-spellcheck
+Author: Asad Khalid
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyspellchecker>=0.7.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Git Spellcheck
+
+Spelling mistakes in commit messages can easily occur, especially when using the CLI with `git commit -m`.  
+
+This tool aims to be quick and easy to set up, while also being lightweight. It automatically checks for spelling errors
+in commit message and provides an option to interactively fix them without rewriting the entire message.
+## How To Use
+
+1. Install from PyPi: 
+    ```bash
+    pip install git-spellcheck
+    ```
+2. Either setup:
+
+    **Global installation** for all repositories:
+    
+    ```bash
+    git-spellcheck --install-global
+    ```
+    
+    OR **local installation** only for current repository
+    ```bash
+    git-spellcheck --install-local
+    ```
+
+3. Commit as usual 
+    ```bash
+   git commit -m "Fix autentcation bug in login modul"
+   ```
+   If spelling mistakes are found, you'll see:
+    ```
+    Git Spellcheck Warning:
+    - "autentcation" (suggestions: authentication)
+    - "modul" (suggestions: module, moduli, model, mosul, mogul, modal)
+   Run `git-spellcheck --fix` to amend.```
+   
+4. Fix last commit interactively
+    ```bash
+    git-spellcheck --fix
+   ```
+   Interactive mode lets you:
+   - See spelling suggestions 
+   - Enter replacements 
+   - Automatically amend your last commit
+   
+   ```
+       - "autentcation"
+       suggestions: authentication
+       Enter replacement (or press ENTER to skip):
+    ```
+5. The commit is now ready to be pushed.
+   
+
+## Behavior
+
+When a commit is made, the subject line is scanned for misspelled words using `pyspellchecker`. If issues are found, suggestions are displayed.
+
+The interactive mode allows reviewing each misspelled word and optionally replacing it, automatically amending the last commit with the corrected message.
+
+Adding `[skip-spell]` to a commit message bypasses the spellcheck. The flag is automatically removed before finalising 
+the commit.
+
+## Requirements
+
+- Python 3.7 or higher  
+- Git

git_spellcheck-0.1.0/git_spellcheck.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+git_spellcheck/__init__.py
+git_spellcheck/cli.py
+git_spellcheck.egg-info/PKG-INFO
+git_spellcheck.egg-info/SOURCES.txt
+git_spellcheck.egg-info/dependency_links.txt
+git_spellcheck.egg-info/entry_points.txt
+git_spellcheck.egg-info/requires.txt
+git_spellcheck.egg-info/top_level.txt

git_spellcheck-0.1.0/git_spellcheck.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

git_spellcheck-0.1.0/git_spellcheck.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+git-spellcheck = git_spellcheck.cli:main

git_spellcheck-0.1.0/git_spellcheck.egg-info/requires.txt

@@ -0,0 +1 @@
+pyspellchecker>=0.7.0

git_spellcheck-0.1.0/git_spellcheck.egg-info/top_level.txt

@@ -0,0 +1 @@
+git_spellcheck

git_spellcheck-0.1.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"

git_spellcheck-0.1.0/setup.cfg

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

git_spellcheck-0.1.0/setup.py

@@ -0,0 +1,27 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="git-spellcheck",
+    version="0.1.0",
+    license="MIT",
+    packages=find_packages(),
+    install_requires=[
+        "pyspellchecker>=0.7.0"
+    ],
+    entry_points={
+        "console_scripts": [
+            "git-spellcheck=git_spellcheck.cli:main"
+        ]
+    },
+    python_requires=">=3.7",
+    description="Interactive Git commit message spellchecker",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    author="Asad Khalid",
+    url="https://github.com/Asad-K2025/git-spellcheck",
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+)