Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 2.17 KB

README.md

File metadata and controls

67 lines (43 loc) · 2.17 KB
Raw

kle_scraper

kle_scraper is a Python library for scraping the key top images of keyboard-layout-editor.com (KLE).

It renders KLE screen by CEF (Chromium Embedded Framework) and captures it. It contains KLE codes and works offline, of course.

Limitations

  • No support for custom styles. Key color is always white.

  • Front legend is ignored.

  • Legend color is equal to KLE screen, not the value in properties. KLE screen color is a bit pale than the value in properties.

  • It handles non-rectangle keys (big ass enter and ISO enter) awkwardly. Big ass enter image lacks the left bottom bulge and ISO enter contains the left bottom dent.

  • Crop area isn't pixel-wise precise, especially about rotated keys. The precision is half pixel in KLE screen.

  • It is non-reentrant.

  • It is slow, especially when the layout has a lot of differently rotated keys.

  • It cannot handle extraordinary large layout.

  • Don't care about ERROR:gpu_process_transport_factory.cc and DevTools listening on messages to STDOUT. CEF is an armada of enigmas.

Installation

kle_scraper depends on pykle_serial. kle_scraper isn't published on PyPI, so you need to git clone the repository and install it by pip install . first.

For Python 3.12, 3.11 and 3.10, it depends on cefpython3 v66.1 unofficial. Download the latest whl and install it by pip.

kle_scraper itself isn't published on PyPI too.

Usage

import tempfile
from kle_scraper import scrape

with tempfile.TemporaryDirectory() as image_output_dir:
    keyboard = scrape(kle_json_filename, image_output_dir)

You can find 0.png, 1.png and more in image_output_dir. The filename number corresponds to keyboard.keys's index. keyboard is an instance of pykle_serial.Keyboard.

Otherwise from command line,

python -m kle_scraper kle_json_filename image_output_dir

Dimension of scraped images

Scraped images are magnified to 4x. On KLE screen, 1u key top has 42x42 px. Key layout pitch is 54x54 px. On scraped images, 1u key top (and image size) is 168x168 px and 1u pitch is 216x216 px.