Skip to main content

No project description provided

Project description

Keyboard Heatmap

This project helps to create heatmap of keys in keyboard for some given text. Supports Nepali नेपाली keyboard layout, the popular बकमान(bakamana) for now and the usual qwerty layout. Other layouts will be added in due course.

Installation

Clone the repository and run setup.

git clone https://github.com/pranphy/KeyboardHeatmap
cd KeyboardHeatmap
python3 setup.py install

You will find an executable kbhmap in your path.

Usage

kbhmap --help shows the following

Usage: kbhmap [OPTIONS]

  a tool to generate the keyboard heatmap. It reads the text from  the input
  file and generates the heatmap. The heatmap can be configured.  The output
  heatmap image is saved in a file with name passed  as the `output`
  parameter. The smoothness of the heatmap can be controlld with `-s
  --sigma` option. The resolution of th output image can be set with `-d
  --dpi` parameter.

Options:
  -i, --input TEXT                input file name
  -o, --output TEXT               output file name
  -l, --layout [qwerty|bakamana]  keyboard layout to use
  -s, --sigma FLOAT               sigma value to smoothen heatmap
  -c, --cmap TEXT                 colormap to use
  -d, --dpi INTEGER               dpi of resulting image
  --help                          Show this message and exit.

Example

For example if you want to see the heatmap of keys in a file named test.txt and output the heatmap image as heatmap_test.png you will do the following

kbhmap -i test.txt -o heatmap_test.png

You can configure other options. Cmap takes any valid matplotlib color map. passing --dpi=100 sets the dpi of output image to 100. The smoothing --sigma parameter is to smooth out the heatmap. Since the keys have precise location they will have high density at the key location and sharp fall at th key edge. If sigma is supplied it applies gaussian smoothing to the heatmap to make it smoother and nicer.

See notebook for usage as a library.

Outputs

Example heatmap for QWERTY An example heatmap

Example heatmap for बकमान An example heatmap

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

kbhmap-0.5.4.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

kbhmap-0.5.4-py3.7.egg (1.0 MB view details)

Uploaded Egg

File details

Details for the file kbhmap-0.5.4.tar.gz.

File metadata

  • Download URL: kbhmap-0.5.4.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for kbhmap-0.5.4.tar.gz
Algorithm Hash digest
SHA256 394a6249d7ac180dc772a7315e109491962da3765aaaaa99bab9874737f51deb
MD5 9025409d95683018045f978862bbb791
BLAKE2b-256 c6708dc1c4c38868307de2a4b461c43271647cf202e98761170b1581a2d89559

See more details on using hashes here.

File details

Details for the file kbhmap-0.5.4-py3.7.egg.

File metadata

  • Download URL: kbhmap-0.5.4-py3.7.egg
  • Upload date:
  • Size: 1.0 MB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for kbhmap-0.5.4-py3.7.egg
Algorithm Hash digest
SHA256 3b0ab96567eb64df57e8ac3aa2a399b1c9fcf35416a4e54ba9759f6d65d40b58
MD5 65ba90ede23cd28e9fe446eb7bf4cb2c
BLAKE2b-256 dae29a04749662716206bf2c36ecb43dfe325ab10b94b8f97d9cb560a05eb11d

See more details on using hashes here.

Supported by

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