Generate keyboards and keyboard layouts for various operating systems.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples
kbdgen
raw
.flake8
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.rst
pyproject.toml

README.rst

kbdgen

https://travis-ci.org/divvun/kbdgen.svg?branch=master

Generate keyboards and keyboard layouts for various operating systems.

Requires Python 3.4 or higher.

Installation

From PyPI

$ pip install kbdgen

From source

Assuming the current working directory is a checked out version of this repo:

$ pip install -r requirements.txt
$ pip install .

You can also use the tools in development easily without installing:

$ python -m kbdgen [...]

This will run the primary kbdgen tool. You may also access the CLDR tooling my this method:

$ python -m kbdgen.cldr {cldr2kbdgen,kbdgen2cldr} [...]

Targets

The following targets are currently supported by kbdgen:

  • Android (built on Linux or macOS)
  • iOS (built on macOS)
  • Windows 7 and later (source generated on any OS, built on Windows)
  • macOS (built on macOS)
  • X11 (built on any OS)
  • SVG (built on any OS)

The code is known to run well on macOS and Linux. Different generators have different OS requirements as specified in their documentation.

Patches to extend support more broadly and add further targets are highly welcomed!

Housekeeping

To generate the documentation, run asciidoctor index.adoc in the docs directory.

License

Apache 2 license. See LICENSE.

Thanks

Development of this project was sponsored by UiT The Arctic University of Norway.