gramcheck 0.1.0__py3-none-any.whl

gramcheck-0.1.0.dist-info/METADATA

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: gramcheck
+Version: 0.1.0
+Summary: Use LLMs to check grammar.
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/degD/gramcheck
+Project-URL: Issues, https://github.com/degD/gramcheck/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colored>=2.3.2
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: google-genai>=2.8.0
+Dynamic: license-file
+
+# GRAMCHECK
+This is a Python tool to check text for grammar mistakes using online LLMs. It uses [Google AI Studio](https://aistudio.google.com/) under the hood. You must provide your own API key. Because of the probabilistic nature of LLMs, the results may or may not be correct. Take them with a grain of salt. However, results are generated using a predefined seed to keep them consistent.
+
+## Install
+1. Install from PyPI: `pipx install gramcheck`.
+2. Set your API key: `gramcheck --set-api-key <YOUR_API_KEY_HERE>` (writes to `.env` in the project directory).
+
+## Usage
+1. Check a file: `gramcheck example.txt`.
+2. Check a single text: `gramcheck -t "Your text here"`.
+3. Check the Nth line in a file: `gramcheck example.txt -n 0`.
+4. Check a file as a whole: `gramcheck example.txt -a`.
+5. Show help: `gramcheck --help`.
+
+## Development
+1. Install the [`uv`](https://docs.astral.sh/uv/) project manager.
+2. Clone the project and run `uv sync`.
+3. Set your API key in `.env` as shown above.
+4. Run locally with `python gramcheck.py` or `./gramcheck`.

gramcheck-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+gramcheck.py,sha256=gNoOge1p0fM6X_Pa92dXIn5uzsZTZEgkKHnpNsYyUUg,6558
+gramcheck-0.1.0.dist-info/licenses/LICENSE,sha256=LheyDQWAAO2gfWxIDAIIjJAbhkKDyX-ZMULGOfCtdwg,1061
+gramcheck-0.1.0.dist-info/METADATA,sha256=02wA16zd-fF5CvfuEHBG_2frJBUOAE05KARhmUAVIxA,1592
+gramcheck-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+gramcheck-0.1.0.dist-info/entry_points.txt,sha256=CHeTUGfxpfWclKLn_b7nvAga-usrmqB77SNCxnT2A3g,44
+gramcheck-0.1.0.dist-info/top_level.txt,sha256=aIJdy0dEvH-EwoQMp_eNW8z-pjfUgb0Ovn_kydXiNtU,10
+gramcheck-0.1.0.dist-info/RECORD,,

gramcheck-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

gramcheck-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gramcheck = gramcheck:cli

gramcheck-0.1.0.dist-info/licenses/LICENSE

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

gramcheck-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+gramcheck

gramcheck.py

@@ -0,0 +1,225 @@
+import argparse
+import os
+import sys
+
+import dotenv
+from colored import Fore
+from google import genai
+from google.genai import types
+
+
+def get_config_env_path() -> str:
+    project_root = os.path.dirname(os.path.abspath(__file__))
+    return os.path.join(project_root, ".env")
+
+
+SEED = 4224442
+API_KEY_PROVIDED = True
+CONFIG_ENV_PATH = get_config_env_path()
+dotenv.load_dotenv(CONFIG_ENV_PATH)
+dotenv.load_dotenv()
+
+try:
+    client = genai.Client()
+except ValueError:
+    API_KEY_PROVIDED = False
+
+file_read_error = "Unable to read from file. Please try again."
+
+number_error = 'Text number "-n" is not an integer.'
+
+number_range_error = "The number specified is not in the range of number of texts in file (counting starts from 0)."
+
+
+def set_api_key(api_key: str) -> str:
+    env_path = CONFIG_ENV_PATH
+    os.makedirs(os.path.dirname(env_path), exist_ok=True)
+
+    lines = []
+    if os.path.exists(env_path):
+        with open(env_path) as fp:
+            lines = fp.read().splitlines()
+
+    updated = False
+    for index, line in enumerate(lines):
+        if line.startswith("GEMINI_API_KEY="):
+            lines[index] = f"GEMINI_API_KEY={api_key}"
+            updated = True
+            break
+    if not updated:
+        lines.append(f"GEMINI_API_KEY={api_key}")
+
+    with open(env_path, "w") as fp:
+        fp.write("\n".join(lines).rstrip("\n") + "\n")
+
+    return env_path
+
+
+def build_arg_parser() -> argparse.ArgumentParser:
+    return argparse.ArgumentParser(
+        prog="gramcheck",
+        description=(
+            "Read lines from FILE and check them for grammatical errors using LLMs.\n"
+            'Or grammar check TEXT with "-t" option.\n'
+            'To check Nth text in FILE, use the "-n" option.\n'
+            'To check FILE as a whole, use option "-a".'
+        ),
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+
+
+def parse_text_number(value: str) -> int:
+    try:
+        return int(value)
+    except ValueError as exc:
+        raise argparse.ArgumentTypeError(number_error) from exc
+
+
+def text_grammar_check(text: str):
+    response = client.models.generate_content(
+        model="gemini-3.1-flash-lite",
+        contents=text,
+        config=types.GenerateContentConfig(
+            system_instruction="You are a tool made for language teaching. Check the text given by the user sentence by sentence for syntactic and semantic errors. Strictly avoid any greetings or filler.",
+            seed=SEED,
+        ),
+    )
+    return response.text
+
+
+def flatten_list(l: list):
+    l_flat = []
+    count = 0
+    for l_inner in l:
+        if isinstance(l_inner, list):
+            count += 1
+            l_flat.extend(l_inner)
+    if count == 0:
+        return l
+    else:
+        return flatten_list(l_flat)
+
+
+def parse_long_text(text: str):
+    word_count = len(text.split())
+    if word_count < 40_000:
+        return text
+    else:
+        text_first_half = " ".join(text.split()[: word_count // 2])
+        text_second_half = " ".join(text.split()[word_count // 2 :])
+        return flatten_list(
+            [parse_long_text(text_first_half), parse_long_text(text_second_half)]
+        )
+
+
+def parse_file_text(file_text: str):
+    texts = []
+    for text in file_text.splitlines():
+        if text:
+            texts.append(parse_long_text(text))
+    return texts
+
+
+def parse_only_file_text(file_text: str):
+    texts = []
+    for text in file_text.splitlines():
+        if text:
+            texts.append(text)
+    return texts
+
+
+def read_from_file(path: str):
+    with open(path) as fp:
+        file_text = "".join(fp.readlines())
+        return file_text
+
+
+def main(texts: list[str]):
+    responses = []
+    for text in texts:
+        responses.append(text_grammar_check(text))
+
+    for i in range(len(texts)):
+        print("\n" + "#" * os.get_terminal_size().columns + "\n")
+        print(f"{Fore.red}{texts[i]}\n\n{Fore.green}{responses[i]}{Fore.white}")
+    print("\n" + "#" * os.get_terminal_size().columns + "\n")
+
+
+def cli():
+    parser = build_arg_parser()
+    parser.add_argument("file", nargs="?", help="File to read")
+    parser.add_argument("-t", "--text", help="Text to check")
+    parser.add_argument(
+        "-n",
+        "--number",
+        type=parse_text_number,
+        help="Check Nth text in FILE (0-based)",
+    )
+    parser.add_argument(
+        "-a",
+        "--all",
+        action="store_true",
+        help="Check FILE as a whole",
+    )
+    parser.add_argument(
+        "--set-api-key",
+        metavar="KEY",
+        help="Store GEMINI_API_KEY in the user config",
+    )
+
+    args = parser.parse_args()
+
+    if args.set_api_key:
+        if args.text or args.file or args.number is not None or args.all:
+            parser.error("--set-api-key cannot be combined with other options")
+        env_path = set_api_key(args.set_api_key)
+        print(f"Saved GEMINI_API_KEY to {env_path}")
+        sys.exit(0)
+
+    if API_KEY_PROVIDED:
+        if not args.text and not args.file:
+            parser.print_help()
+            sys.exit(0)
+        if args.text and args.file:
+            parser.error("FILE and -t/--text cannot be used together")
+        if args.text and args.number is not None:
+            parser.error("-n/--number cannot be used with -t/--text")
+        if args.number is not None and not args.file:
+            parser.error("-n/--number requires FILE")
+        if args.all and not args.file:
+            parser.error("-a/--all requires FILE")
+        if args.all and args.text:
+            parser.error("-a/--all cannot be used with -t/--text")
+    else:
+        parser.error(
+            "No API key was provided. Please pass a valid API key using --set-api-key"
+        )
+
+    if args.text:
+        texts = parse_file_text(args.text)
+    else:
+        try:
+            file_text = read_from_file(args.file)
+        except:
+            sys.stderr.write(file_read_error + "\n")
+            sys.exit(1)
+
+        if args.number is not None:
+            file_texts = parse_only_file_text(file_text)
+            if args.number < 0 or args.number >= len(file_texts):
+                sys.stderr.write(number_range_error + "\n")
+                sys.exit(3)
+            file_text = file_texts[args.number]
+            texts = parse_file_text(file_text)
+        elif args.all:
+            text_or_texts = parse_long_text(file_text)
+            texts = (
+                text_or_texts if isinstance(text_or_texts, list) else [text_or_texts]
+            )
+        else:
+            texts = parse_file_text(file_text)
+    main(texts)
+
+
+if __name__ == "__main__":
+    cli()