Metadata-Version: 2.4
Name: typodetect
Version: 1.1.0
Summary: A lightweight background tool that detects when you mistype a specific word and gives you a visual warning.
Author: Skip-SBT
License: MIT
Project-URL: Homepage, https://github.com/Skip-SBT/TypoDetect
Project-URL: Repository, https://github.com/Skip-SBT/TypoDetect
Project-URL: Issues, https://github.com/Skip-SBT/TypoDetect/issues
Keywords: typo,detection,keyboard,tray,monitoring
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: keyboard>=0.13.5
Requires-Dist: rapidfuzz>=3.0.0
Requires-Dist: pynput>=1.7.6
Requires-Dist: pystray>=0.19.4
Requires-Dist: Pillow>=10.0.0
Dynamic: license-file

# TypoDetect

A lightweight background tool that detects when you mistype a specific word (like your name) and gives you a subtle visual warning.

It runs silently in the background, shows a tray icon, logs activity, and lets you configure everything from the system tray.

## Features

- 🔍 Detects typos of a chosen word in real time
- 🌐 Works globally across all applications
- 🔴 Red screen-border flash when a typo is detected
- 🖥️ System tray icon with full controls
- ⏸️ Enable / disable monitoring anytime
- 🎚️ Adjustable strictness (Strict / Normal / Relaxed)
- 💾 Persistent settings saved across restarts
- 📝 Built-in logging with quick access
- 🛡️ Crash logging and heartbeat monitoring
- 🔄 Auto-recovery watchdog for input hooks

## Installation

### Install from source (pip)

```bash
pip install .
```

This installs TypoDetect and all its dependencies. After installation you can launch it with:

```bash
typodetect
```

### Install in development mode

```bash
pip install -e .
```

### Build a standalone executable

If you prefer a single `.exe` that doesn't require Python:

```bash
pip install pyinstaller
pyinstaller --noconsole --onefile typodetect/name_guard.py
```

The executable will be in `dist/name_guard.exe`.

## Auto-start on Windows

1. Press <kbd>Win</kbd> + <kbd>R</kbd>
2. Enter: `shell:startup`
3. Copy the executable (or a shortcut) into that folder

## Usage

### Tray Icon

After starting, a small icon appears in your system tray:

| Icon | Meaning |
|------|---------|
| 🟢 Green | Monitoring enabled |
| ⚪ Grey  | Monitoring disabled |

Right-click the icon to open the menu.

### Menu Options

| Option | Description |
|--------|-------------|
| **Enable / Disable** | Turn detection on or off instantly |
| **Set Target Word** | Choose the word you want monitored (saved permanently) |
| **Strictness** | Adjust sensitivity — *Strict*, *Normal* (recommended), or *Relaxed* |
| **Open Log** | Opens the log file |
| **Clear Log** | Clears all log entries |
| **Open App Folder** | Opens the folder where logs and settings are stored |
| **Exit** | Fully stops the app |

## License

This project is licensed under the [MIT License](LICENSE).
