Metadata-Version: 2.1
Name: typeshit
Version: 0.2
Summary: wrong lang? you got typeshit
Home-page: https://github.com/Ebrahim-Ramadan/wetype-tool
Author: Ebrahim Ramadan
Author-email: ramadanebrahim791@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pynput
Requires-Dist: langdetect

# Typeshit

![Typeshit Illustration](illustration.mp4)

Typeshit is a Python tool that detects and corrects text input, particularly useful for switching between Arabic and English typing.

## Installation

Install Typeshit using pip:
`pip install typeshit`
It's recommended to use a virtual environment for isolated package management.

## Usage

After installation, activate Typeshit from your command line:
`typeshit`
The tool will start listening for keyboard input and automatically correct text based on the detected language.

## How It Works

Typeshit uses a debounce mechanism to process input efficiently:

1. Each keypress triggers a timer reset.
2. If no keys are pressed within the debounce delay, the `process_buffer` function is called.
3. The function then processes the accumulated input, detecting the language and applying necessary corrections.

## Features

- Automatic language detection (Arabic/English)
- Real-time text correction
- Efficient input processing with debounce mechanism

## Development

For contributors and developers:

- `test.txt` is provided for input testing purposes.
- The main logic resides in `src/typeshit/main.py`.

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contact

Ebrahim Ramadan - [ramadanebrahim791@gmail.com](mailto:ramadanebrahim791@gmail.com)

Project Link: [https://github.com/ebrahim-ramadan/wetype](https://github.com/ebrahim-ramadan/wetype)
