https://github.com/mohamedch7/correctly
The AI-Powered Keyboard Layout Fixer. Tired of typing in the wrong keyboard layout? Correctly automatically detects and corrects your typing mistakes using AI
https://github.com/mohamedch7/correctly
ai correction keyboard-layout
Last synced: 4 months ago
JSON representation
The AI-Powered Keyboard Layout Fixer. Tired of typing in the wrong keyboard layout? Correctly automatically detects and corrects your typing mistakes using AI
- Host: GitHub
- URL: https://github.com/mohamedch7/correctly
- Owner: mohamedch7
- License: mit
- Created: 2024-10-26T19:54:29.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-26T21:23:00.000Z (6 months ago)
- Last Synced: 2024-10-28T00:45:07.888Z (6 months ago)
- Topics: ai, correction, keyboard-layout
- Language: Python
- Homepage:
- Size: 12.7 KB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Correctly
**Correctly** is an intelligent typing tool that understands your typing intent, even if you're using the wrong keyboard layout. Forget about switching languages manually—Correctly detects and corrects mistyped input, ensuring your message comes out just as you intended.
https://github.com/user-attachments/assets/84d802de-d99e-4667-b545-0ca6784c5ae6
## Features
- **Automatic Keyboard Layout Detection**: Detects if you're using the wrong layout and automatically corrects it.
- **AI-Powered Correction**: Uses AI to understand the intended text and corrects typing mistakes caused by using the wrong layout.
- **Supports Multiple Languages**: Correctly works with multiple language layouts, including English and Arabic (or others with customization).
## How It Works
Correctly listens to your keyboard input, and after a brief delay, analyzes what you typed. Using AI, it detects if the input doesn't match the intended language and corrects it accordingly.
For example, if you forget that your keyboard layout is set to Arabic and you start typing in English, Correctly will automatically convert “اثممخ صخقمي” to “hello world”.
## Installation
1. Clone this repository:
```sh
git clone https://github.com/mohamedch7/correctly.git
cd correctly
```
2. Install the required dependencies:
```sh
pip install -r requirements.txt
```
3. Set up your `.env` file with your OpenAI API key:
```
OPENAI_API_KEY=your_openai_api_key_here
```
## Usage
Run the Python script to start listening to your keyboard input:
```sh
python3 script.py
```
Correctly will start running in the background and automatically correct your typing if you use the wrong keyboard layout.
## Configuration
- **Keyboard Layouts**: You can customize the English and Arabic keyboard layouts in the `script.py` file by editing the `ENGLISH_LAYOUT` and `ARABIC_LAYOUT` constants.
## Requirements
- Python 3.7+
- `pynput` for capturing keyboard input.
- `openai` for AI-powered correction.
- `python-dotenv` for loading environment variables.
## Example
If you mistakenly type `اثممخ صخقمي` while intending to write `hello world`, Correctly will detect the wrong layout and convert it automatically to `hello world`.
## Contributing
Contributions are welcome! Feel free to submit issues or pull requests to improve Correctly.
## License
This project is licensed under the MIT License. See the `LICENSE` file for more details.
## Acknowledgments
- Thanks to OpenAI for providing the powerful language model used to correct mistyped input.
- Inspired by the challenge of switching between language layouts seamlessly while typing.
## Contact
If you have any questions or feedback, please reach out at [[email protected]].