Metadata-Version: 2.4
Name: typeman
Version: 0.1.1
Summary: Add your description here
Project-URL: Repository, https://github.com/Sai-Suraj-27/Typeman
Project-URL: Issues, https://github.com/Sai-Suraj-27/Typeman/issues
Project-URL: Homepage, https://github.com/Sai-Suraj-27/Typeman
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: readchar>=4.2.1
Requires-Dist: ruff>=0.12.2
Requires-Dist: typer>=0.16.0
Dynamic: license-file

# Typeman
A terminal‑based typing-speed test CLI tool that shows **real-time feedback**, **WPM**, and **accuracy** in a beautiful, live interface built with **Typer** and **Rich**.


## ✨ Why Typeman?

- Fast, interactive, and cross-platform 🧭  
- Live-color feedback: correct keystrokes turn **green**, mistakes in **red**  
- Custom cursor highlights typing position  
- Uses a built-in 10k word list for realistic, daily vocabulary  
- No external dependencies beyond Python packages  


## 🚀 Installation

**Create a virtual environment using [uv](https://docs.astral.sh/uv/getting-started/installation/)**

```bash
uv venv .type
```

**Activate the virtual environment**

```bash
source .type/bin/activate
```

**Install Typeman into your isolated `.type` virtual environment**

```bash
uv pip install typeman
```

### Alternatively, if you prefer traditional tools

```bash
python3 -m venv .venv      # Create a virtual environment
source .venv/bin/activate
pip install typeman        # Standard pip install
```

## Usage

### 🔸 Run a 30-second typing test (seconds must be 0–60)
```bash
typeman 30 
```

## Demo

https://github.com/user-attachments/assets/5f087a16-bcae-463c-b1e1-ec984ab858ee
