Metadata-Version: 2.4
Name: termtypr
Version: 1.0.0
Summary: A Python CLI application for practicing and improving typing speed
Keywords: typing,cli,practice,speed,terminal
Author: Stefano Mazzoleni
License-Expression: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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: Programming Language :: Python :: 3.14
Classifier: Topic :: Utilities
Requires-Dist: rich~=15.0
Requires-Dist: textual~=8.0
Requires-Dist: plotext~=5.3
Requires-Dist: typer~=0.24
Requires-Dist: platformdirs~=4.9
Requires-Dist: pydantic~=2.12
Requires-Python: >=3.10
Project-URL: Repository, https://github.com/SteMazzO/TermTypr
Project-URL: Changelog, https://github.com/SteMazzO/TermTypr/blob/main/CHANGELOG.md
Project-URL: Bug Tracker, https://github.com/SteMazzO/TermTypr/issues
Description-Content-Type: text/markdown

# TermTypr

[![License: MIT](https://img.shields.io/github/license/SteMazzO/termtypr?logo=Open+Source+Initiative)](https://opensource.org/license/mit)
[![PyPI version](https://img.shields.io/pypi/v/termtypr?logo=pypi)](https://pypi.org/project/termtypr/)
[![PyPI Python](https://img.shields.io/pypi/pyversions/termtypr?logo=pypi)](https://pypi.org/project/termtypr/)
[![codecov](https://codecov.io/github/SteMazzO/termtypr/coverage.svg?branch=main)](https://codecov.io/github/SteMazzO/termtypr?branch=main)

Practice your typing right in the terminal. Track your speed, see where you improve, and have fun doing it.

## What it does

- **Three game modes**: random words, full phrases, or racing your own ghosts
- **Live feedback**: WPM and accuracy update as you type
- **Stats & charts**: see your history, personal bests, and trends over time
- **Customizable**: set the word count per game, switch themes, add your own words
- **Runs anywhere**: works on any terminal with Python 3.10+

## Install and run

```bash
pip install termtypr
termtypr
```

That's it. The main menu lets you pick a game mode and start typing.

## Games

- **Random Words**: type a batch of random words as fast and accurately as you can
- **Phrase Typing**: type full phrases and quotes to build flow
- **Race a Ghost**: race a keystroke-perfect replay of one of your best runs

Your best phrase runs are saved as **ghosts** automatically (change that in
**Ghost Settings**, `Ctrl+P`). Press `R` on a phrase result to rematch its ghost.

## CLI commands

```bash
termtypr                        # Launch the app
termtypr stats                  # Quick stats from the command line
termtypr add-words word1 word2  # Add your own words to the pool
termtypr list-words             # See all available words
```

## Development

### Setup Development Environment

```bash
git clone https://github.com/SteMazzO/termtypr.git
cd termtypr
uv run termtypr
```

### Run Tests

```bash
uv run pytest -v
```

## Contributing

Contributions are welcome - see [CONTRIBUTING.md](CONTRIBUTING.md).

## License

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

## Acknowledgments

- Inspired by [MiType](https://github.com/Mithil467/mitype), [10FastFingers](https://10fastfingers.com/), and [TypeRacer](https://play.typeracer.com/)
- Text samples from [Typeracer Data](http://typeracerdata.com/texts)
- Built with [Textual](https://github.com/Textualize/textual) by Textualize

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for version history and release notes.
