tui-typer-tutor

Uncomplicated terminal typing practice.

Fork of kraanzu/termtyper with a focus on special characters. Inspired by climech/typing-practice and justinsgithub/terminal-typing-tutor.

Installation

Install with pipx

pipx install tui-typer-tutor

Usage

Launch a typing session with the default text:

ttt

Or specify custom files with:

ttt --seed-file='./any-file.txt'

To uninstall run:

ttt --uninstall && pipx uninstall tui-typer-tutor

Keys

This app supports a few unicode characters when found in the seed file:

• tab: →
• shift+tab: ←
• enter/return: ⏎
• escape: ␛

All supported characters are documented here. Ctrl key combinations aren't yet supported and appear as an unknown character.

Seed File

The algorithm for generating the expected text is:

1. Load each line of the seed file
2. Reorder randomly (keeping each line of text together)
3. Join without a delimeter keeping any leading white space per line

The default seed file is here: ./tui_typer_tutor/core/seed_data.txt

Ideas for better seed text generation are welcome!

Project Status

See the Open Issues and/or the CODE_TAG_SUMMARY. For release history, see the CHANGELOG.

Contributing

We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:

• DEVELOPER_GUIDE
• STYLE_GUIDE

Code of Conduct

We follow the Contributor Covenant Code of Conduct.

Open Source Status

We try to reasonably meet most aspects of the "OpenSSF scorecard" from Open Source Insights

Responsible Disclosure

If you have any security issue to report, please contact the project maintainers privately. You can reach us at dev.act.kyle@gmail.com.

License

LICENSE