Kabsa

A simple and lightweight tool to log key presses and WPM (Words Per Minute) in real-time.

The name Kabsa (pun intended) is inspired by the Saudi dish Kabsa. It also means "click" in Arabic, which is what Kabsa does, it logs your key presses.

Table of Contents

• Installation
• Motivation
• How it works
• Features

Installation

You have 2 options to use Kabsa:

1. Use it locally with go installed on your machine, by running the following command:

make run

2. If you don't have make installed, you can run the following commands:

go build -o bin/kabsa cmd/main.go
bin/kabsa

3. Use Docker to run the containerized version of Kabsa:

sudo docker build -t kabsa .
sudo docker run --rm --privileged -v /dev/input:/dev/input -e DB_PATH=/app/data/kabsa.db -v $(pwd)/data:/app/data kabsa

Motivation

I discovered MoneyType a few monthes ago, and I liked the idea and how smooth it is. I wanted to create a similar tool but with a different approach. I wanted to create a tool that logs key presses and calculates the WPM in real-time (not just in a controlled environment). I also wanted to know my way around Go, so I decided to create Kabsa

How it works

I wanted to have a reference for my numbers so I used the same formula that MoneyType uses to calculate the WPM. You can find the formula on their about page:

wpm - total number of characters in the correctly typed words (including spaces), divided by 5 and normalised to 60 seconds.

raw wpm - calculated just like wpm, but also includes incorrect words.

I only can calculate the raw WPM, as I don't have a way to know if the word is correct or not. I also don't have a way to know the total number of characters in the correctly typed words. So I just calculate the raw WPM

Features

The goal of Kabsa is to be a simple and lightweight tool to log key presses and calculate the WPM in real-time. Here are some of the features that Kabsa is intended to have:

• Log key presses
• Calculate the WPM in real-time
• Display the WPM in real-time
• Do some input validation (e.g.: don't allow the same key to be pressed more than (n) in a row)
• Save the WPM and cumulative characters count to a database (sqlite)
• Do some analysis on the WPM
• Display the analysis in a dashboard (Somehow XD)

Benchmarks

I will try to do some benchmarks to see how Kabsa performs compared to monkeyType and update this section with the results