This project provides a script that uses OpenAI's API to improve text by correcting grammar, syntax, and idioms while preserving the original meaning. The script can be triggered using a hotkey.
- Python
- pip
-
Clone the repository:
git clone <repository-url> cd <repository-directory>
-
Install the required packages:
pip install -r requirements.txt
-
Set your OpenAI API key in the
run_hotkey.bat
file or as an environment variableOPENAI_API_KEY
. -
Optionally, you can configure the hotkey, model, and prompt in the
run_hotkey.bat
file.
-
Run the
run_hotkey.bat
file to start the script:run_hotkey.bat
-
The script will run in the background. Press the configured hotkey (default is
ctrl+f11
) to improve the text.
hotkey.py
: The main script that handles the hotkey and text improvement.requirements.txt
: Lists the required Python packages..gitignore
: Specifies files and directories to be ignored by git.run_hotkey.bat
: Batch file to set up and run the script.settings.txt
: Optional file to load settings from.
This project is licensed under the MIT License.