Metadata-Version: 2.4
Name: autocorrect_linux
Version: 0.3.0
Summary: System-wide autocorrect for Linux
Author-email: simon0302010 <simon0302010@gmail.com>
License-Expression: GPL-3.0
Project-URL: Homepage, https://github.com/simon0302010/autocorrect-linux
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: pynput
Requires-Dist: requests
Requires-Dist: customtkinter
Requires-Dist: distance
Dynamic: license-file

![Hackatime](https://hackatime-badge.hackclub.com/U08HC7N4JJW/autocorrect-linux)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/simon0302010/autocorrect-linux/.github%2Fworkflows%2Fpython-package.yml)
![PyPI - Version](https://img.shields.io/pypi/v/autocorrect_linux)


# autocorrect-linux

**autocorrect-linux** is a system-wide autocorrect tool for Linux desktops. It provides real-time spelling suggestions and corrections for any application, using a global keyboard listener and a floating GUI.

## Features

- Real-time autocorrect suggestions for any window
- Custom personal word list (PWL) support
- Words flagged as incorrect get added PWL after being used 3 times
- Always-on-top floating GUI (When activated)
- Fast next-word recommendations using Machine Learning (planned)

## Requirements

- Linux
- X11

## Installation

Install dependencies:

Arch Linux:
```bash
sudo pacman -S xorg-xprop
```

Debian/Ubuntu:
```bash
sudo apt install x11-utils
```

Install the package:
```bash
pip install autocorrect_linux
```

## Usage

```bash
python -m autocorrect_liunx
```
The floating window will appear at your mouse cursor, showing suggestions as you type.
