typefast

A CLI application for measuring your typing speed.
Report Bug or Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Measuring typing speed is a fun and diverting activity that can be done in a short amount of time. When taking a break, too short for playing games or watching series, but too long to only drink a cup of water, speed typing is ideal. However, mostly typing speed can be measured on websites such as 10fastfingers or monkeytype. While they do the job, they require a browser, javascript, or even cookies.

Typefast is a CLI application that does the same like monkeytype, but in the terminal! It is cross platform and binds in well in the terminal. Starting and doing a few quick speed typing test has never been smoother. It collects random quotes from BrainyQuote for typing tests. Other speed tests like most words within a minute, etc. are WIP. It is very lightweight and uses very little dependencies.

(back to top)

Built With

• Python 3
• Beautiful Soup
• tqdm
• requests
• curses

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• Have pip installed (different methodes explained here)

  python -m ensurepip --upgrade

• upgrade pip to its most recent version

  pip install --upgrade pip

Installation

1. Clone the repo

   git clone https://github.com/Neihtq/typefast
   cd typefast

2. Install dependencies

   pip install -r requirements.txt

3. Run application

   python main.py

(back to top)

Usage

• The timer will only start after the first character has been entered
• Hitting the space button will submit the current word and therefore you cannot edit the previous input anymore (e.g. deleting with backspace)
• This application calculates your Words per minute (WPM) metric. Other metrics are WIP
• After finishing a test, it will automatically start a new one after 5 seconds
• You can restart with a new quote by pressing esc key

(back to top)

Roadmap

• Add Changelog
• Different modes
  • Enter many words within a minute
• Make typefast von usr/bin executable i.e. typefast as a command
• Add tests
• Add different metrics
• Multi-language Support

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Quang Thien Nguyen - [email protected] - LinkedIn

Project Link: https://github.com/Neihtq/typefast

(back to top)