https://github.com/greydevv/typeshell-cli
A Python command-line-interface tool that was written as a proof-of-concept of pytyper, a Python typing test package.
https://github.com/greydevv/typeshell-cli
command-line-tool python typeshell-cli
Last synced: 5 months ago
JSON representation
A Python command-line-interface tool that was written as a proof-of-concept of pytyper, a Python typing test package.
- Host: GitHub
- URL: https://github.com/greydevv/typeshell-cli
- Owner: greydevv
- License: mit
- Created: 2020-10-10T18:11:42.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-10-25T14:04:04.000Z (over 5 years ago)
- Last Synced: 2025-02-22T01:15:45.169Z (12 months ago)
- Topics: command-line-tool, python, typeshell-cli
- Language: Python
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typeshell-cli
## Description
typeshell-cli is a Python command-line-interface tool that was written as a proof-of-concept of [pytyper](https://github.com/greysonDEV/pytyper), a Python typing test package.
## Installation
```
pip install typeshell
```
## Usage
#### Basic Usage
```
typeshell [-h] [-V] [-v] create count {proverbs, shakespeare}
```
#### Positional Arguments
```
create create typing session
count number of prompts in session
{proverbs, shakespeare}
type of prompts in session
```
#### Optional Arguments
```
-h, --help show this help message and exit
-V, --version show program version
-v, --verbose increase output verbosity
```
#### Examples
To create a typing session with 3 proverbs:
```
typeshell create 3 proverbs
```
A confirmation input is needed before the typing session begins:
```
*-------[Generating session]-------*
Prompts:
3
Type:
proverbs
*------[Press enter to begin]------*
```
When the session begins, the shell window will be cleared, only displaying the prompt and space for an input:
```
Grief divided is made lighter.
```
Be aware, the timer starts immediately after pressing enter. To exit the current session, stop the shell processes via `KeyboardInterrupt`.
#### Output
Upon finishing a session, the average statistics for that session will be visible:
```
*-------[Finished session]-------*
Average statistics:
Gross-WPM: 71.978
Net-WPM : 58.446
Accuracy : 0.95
Errors : 2.334
Time : 8.102
*----------------------------------*
```
Specifying `--verbose` when creating a typing session will provide an output of each prompt with the user's input, along with an additional line which indicates the errors in the user's input.
```
> Grief divided is made lighter.
$ Grief divided is made lighter.
> A ship in the harbor is safe, but that is not what a ship is for.
$ A ship in the harbor is safe, hut that is not what a ship is for
^ ^
> Every man is the architect of his destiny.
$ Ebery man is the architext of his deinrny.
^ ^ ^^^
```
## License
typeshell is licensed under the [MIT](https://github.com/greysonDEV/typeshell-cli/blob/main/LICENSE) License.