Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DriftingOtter/Typr
Typr: Your Personal Typing Tutor.
https://github.com/DriftingOtter/Typr
cli cli-app python rich-text simple-game typing typing-practice typing-test typingspeedtest
Last synced: about 1 month ago
JSON representation
Typr: Your Personal Typing Tutor.
- Host: GitHub
- URL: https://github.com/DriftingOtter/Typr
- Owner: DriftingOtter
- License: gpl-3.0
- Created: 2023-10-18T09:01:39.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2023-12-31T06:57:21.000Z (6 months ago)
- Last Synced: 2024-02-01T11:06:32.195Z (5 months ago)
- Topics: cli, cli-app, python, rich-text, simple-game, typing, typing-practice, typing-test, typingspeedtest
- Language: Python
- Homepage:
- Size: 1.12 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Lists
- cli-apps - Typr - `typr` is a Python-based application that utilizes the 'rich' module to provide you with a simple yet satisfying TUI when typing, `typr` is designed to be simple and easy to use. (<a name="typing"></a>Typing test and practice)
- awesome-cli-apps - Typr - `typr` is a Python-based application that utilizes the 'rich' module to provide you with a simple yet satisfying TUI when typing, `typr` is designed to be simple and easy to use. (<a name="typing"></a>Typing test and practice)
README
# Typr: Your Personal Typing Tutor :keyboard:.
## Description 📜
> typr is a Python-based application that utilizes the *'rich'* module to provide you with a simple yet satisfying tui when typing, typr is designed to be simple & easy to use; Whenever you want a simple but satisfying typing test tool.
[](https://asciinema.org/a/617774)
## Installation Guide
1. Check Python Version:
Ensure you have Python 3.8 or higher installed. If not, install it from the [official Python website](https://www.python.org/).
### Quick Install
1. Clone typr Repository:
Clone typr repository to your desired location.
```
git clone https://github.com/DriftingOtter/Typr.git
cd TyprCLI
```
2. Run install script:
```
chmod +x install.sh
./install.sh
```
### Manual Install // Manual Build
1. Install rich Python module:
If you have not already done so, install the [rich](https://pypi.org/project/rich/) Python module, as it's a *critical* library for typr.
```
pip install rich
```
2. Clone typr Repository:
Clone typr repository to your desired location using Git
```
git clone https://github.com/DriftingOtter/Typr.git
cd TyprCLI
```
3. Locate main.py:
Make sure you know the correct path to your main.py file within the __TyprCLI/src/__ directory you just cloned.
4. Set up Aliases ___(Optional)*___
Please check with your shell's documentation on how to add aliases to your rc files.
Here are some commonly used shell alias commands you can copy.
#### Bash
Add the following line to your __~/.bashrc__ file:
```
alias typr="python3 /path/to/TyprCLI/src/main.py"
```
#### Zsh
Add the following line to your __~/.bashrc__ file:
```
alias typr="python3 /path/to/TyprCLI/src/main.py"
```
#### Fish
Add the following line to your __~/.config/fish/config.fish__ file:
```
alias typr="python3 /path/to/TyprCLI/src/main.py"
```
#### Xonsh
Add the following line to your __~/.xonshrc__ file:
```
aliases['typr'] = 'python3 /path/to/TyprCLI/src/main.py'
```
5. Test The Alias
Open a new terminal window and type typr. It should execute your typr application.
___You can also run ```typr -h``` to output the manual page for the application to see all the addional run-time flags you can utilize.___
## Contributing
If you want to contribute to this project, please feel free to read the [CONTRIBUTING.md](./CONTRIBUTING.md) document to gain a better understanding of how to make changes, and improve this application.
## Acknowledgements
- [Freepik.com](https://www.freepik.com/free-vector/cute-astronaut-working-with-laptop-space-cartoon-vector-icon-illustration-science-technology_42161336.htm#query=keyboard&position=13&from_view=search&track=sph) for astronaut logo
___(Image by catalyststuff on Freepik)___
- [katto-studios](https://github.com/katto-studios/loki) for the default word list
- [monkeytype](https://github.com/monkeytypegame/monkeytype) for the inspiration for the [CONTRIBUTING.md](./CONTRIBUTING.md) document