Skip to main content

Minimalistic typing exercise

Project description

fasttyper

About

Fasttyper is minimalistic typing test based on user provided exercising text. It supports both reading from text files and stdin supporting wide range of usecases. The goal was to create it as simple as it can be, without any additional bloatware functionalities. That means that Fasttyper doesn't come with build in test generator and you have to provide your own scripts generating tests. Some examples of such scrips are providen in Usage section.

Installation

Fasttyper is currently maintained on PyPi Python Package Index. To install package simpply use:

python3 -m pip install fasttyper

Usage

Fasttyper is ran as an python module, so to execute it simply type:

python3 -m fasttyper

from cloned github repository, if you didn't install package from TestPyPi.

Fasttyper can open text files, which path should be provided as first and only argument to the module execution, for example:

python3 -m fasttyper example_text.txt

Program also allows user to pipe text into it. Keep in mind, it only supports spaces and new line characters, so you won't be able to table tabs. For example, you can run Fasttyper on fortune generated quote changing tabulators to spaces with sed:

furtune | python3 -m fasttyper

or if you want to randomize words from given file with shuf on for example all disctionaries in system:

shuf -n5 /usr/share/dict/* | python -m fasttyper

You can use another similar projects set of words as well, for example to create test with 20 random words from Monkeytype's english 100 dictionary use:

curl -s https://raw.githubusercontent.com/Miodec/monkeytype/master/static/languages/english.json | python3 -c "import sys, json; print('\n'.join(json.load(sys.stdin)['words']))" | shuf -n20 | python3 -m fasttyper

To exit you can either finish test, use KeyboardInterrupt (CTRL+C) or tap tab then enter. After you finish test, there will be summary printed, use enter to exit from it.

When backspace does wierd shiet

Some terminal emulators send different values for key presses of backspace and ctrl+backspace. To fix it, simply add b flag like that: python3 -m fasttyper -b.

Hiding cursor

To hide the cursor, simply add n flag like that: python3 -m fasttyper -n.

Example scripts

function ff() {
	mkdir -p ~/.cache/fasttyper
	local amount="${1:-50}"
	local language="${2:-english}"
	local sfile=~/.cache/fasttyper/$language
	local source_path=https://raw.githubusercontent.com/Miodec/monkeytype/master/static/languages/$language.json
	[[ ! -f $sfile ]] && curl -s $source_path | python3 -c "import sys, json; print('\n'.join(json.load(sys.stdin)['words']))" > $sfile
	while true
	do
		shuf -n $amount $sfile | python3 -m fasttyper || break
	done
}

ff 50 english_1k

This shell function shuffles N words from cached word list, and if given word list doesnt exist it download's it. It runs in loop, but does exit from it if you exit fasttyper with CTRL+C.

The above script is avalible for download from doc folder.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fasttyper-1.5.2.tar.gz (1.3 MB view details)

Uploaded Source

Built Distributions

fasttyper-1.5.2-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

fasttyper-1.5.2-py2.py3-none-any.whl (22.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fasttyper-1.5.2.tar.gz.

File metadata

  • Download URL: fasttyper-1.5.2.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.8.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for fasttyper-1.5.2.tar.gz
Algorithm Hash digest
SHA256 ad6b3682e31fdff9157a7b60956d409a10aad77a616a8cfe16ba15267041d599
MD5 e68bf2a6c36adaf6fb6e573554fead51
BLAKE2b-256 1b73c723c6ce7c64f8142fac6bbbd884fbc8002986b5ed108ef98e0e9ae88cf4

See more details on using hashes here.

File details

Details for the file fasttyper-1.5.2-py3-none-any.whl.

File metadata

  • Download URL: fasttyper-1.5.2-py3-none-any.whl
  • Upload date:
  • Size: 23.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.8.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for fasttyper-1.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 323a5544d0e0b080eea0de63b7845f425068e3bacc58cd2c13a13c3bd21df341
MD5 21e9e63a7727108dff4d4aa2a0bed66a
BLAKE2b-256 599d258511d7fa8fc8baf4199c27c2eb3a09f9520e3d20ebb31ee4e783128c0c

See more details on using hashes here.

File details

Details for the file fasttyper-1.5.2-py2.py3-none-any.whl.

File metadata

  • Download URL: fasttyper-1.5.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 22.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.8.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for fasttyper-1.5.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e203e8e7419804c34064a015076850c23af09d77f54be8d63c469fa14f980e29
MD5 f50ef923230c0b634815a73910b9d82e
BLAKE2b-256 25a213531f9ab56ddeefd5dfd37654fa67bf8e1148af638b856c532332b25443

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page