Metadata-Version: 2.4
Name: terminal-monkeytype
Version: 0.1.0
Summary: CLI typing test inspired by Monkeytype
Author-email: Aaquib Ali <contactaaquibali@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Aaquib Ali
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Keywords: typing,cli,monkeytype,terminal
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# 🐒 Terminal Monkeytype

A **beautiful, minimal, and fast CLI typing test** that runs entirely in your **terminal** — inspired by [Monkeytype](https://monkeytype.com).  
Track your **WPM**, **accuracy**, and view your past results directly in the console.

![terminal-monkeytype-demo](https://user-images.githubusercontent.com/your-username/demo.gif)

---

## ✨ Features

- ⚡ Real-time WPM and accuracy tracking  
- ⏱️ Supports both **Word Count** and **Timed** modes  
- 🧠 Local leaderboard saved automatically  
- 🎨 Beautiful interface
- 💻 Works on **Windows**, **macOS**, and **Linux**

---

## 🧩 Installation

### From [PyPI](https://pypi.org/project/terminal-monkeytype/)
```bash
pip install terminal-monkeytype
```
📝 Make sure your Python version is 3.8 or higher

### Optional (Recommended on macOS/Linux)
If the command isn’t found after install:

```bash
pipx install terminal-monkeytype
pipx ensurepath
```

Then restart your terminal

## 🚀 Usage
Once installed, simply run:

```bash
terminal-monkeytype
```

## 🧭 Choose your mode:

- Words Mode – Test your speed on 25 / 50 / 100 words
- Time Mode – Type for 15s / 30s / 60s / 120s

## 🎯 After completion:
You’ll see your WPM, accuracy, and mistakes along with a mini leaderboard of recent results

## 📊 Example Output

⏱ 60.0s   |   ⚡ 72.5 WPM   |   🎯 96.3%   |   Mistakes: 4
───────────────────────────────────────────────
Test Complete!

Mode: time   WPM: 72.5   Acc: 96.3%   Time: 60s
───────────────────────────────────────────────
Recent Results:
2025-10-07  72.5  96.3  180
2025-10-06  69.8  94.1  120
───────────────────────────────────────────────
[r] Retry    [m] Menu    [q] Quit    [g] Github

## 🧑‍💻 Author
Aaquib Ali <br>
💼 GitHub<br>
📧 Reach out for suggestions or contributions!

## ⚖️ License
This project is licensed under the MIT License – see the LICENSE file for details

## ⭐ Support
If you like this project, consider giving it a ⭐ on GitHub — it helps more people discover it!
