Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 2.76 KB

README.md

File metadata and controls

51 lines (36 loc) · 2.76 KB

Tools

  • layout2image.py - generate KLE style SVG image from keyboard layout
  • layout2url.py - generate KLE url
  • layout2openscad.py - generate plate for openscad (:warning: experimental)

How to run

The kbplacer project uses pyprojet.toml with hatch project manager. It defines tools environment with required dependencies and scripts. To execute, run:

$ hatch run tools:layout2image {args...}
$ hatch run tools:layout2url {args...}
$ hatch run tools:layout2openscad {args...}

Alternatively, install required dependencies and run as regular python script:

python tools/layout2image.py {args...}
python tools/layout2url.py {args...}
python tools/layout2openscad.py {args...}

Examples

To generate layout image based on layout file:

hatch run tools:layout2image --in tests/data/ergogen-layouts/absolem-simple-points.yaml \
  --out absolem.svg

absolem-svg

To generate KLE url for run:

hatch run tools:layout2url --in tests/data/ergogen-layouts/absolem-simple-points.yaml

This will produce following link.

To convert ergogen layouts to KLE see layout and format conversion script

Warning

Tools are not yet part of kbplacer package and are tested mostly by-hand. To execute limited tests we have run hatch run tools:test.