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`.
