Skip to main content

KeyboardViz

A minimal Python library for generating keyboard layout visualizations with custom key mappings.

Installation

pip install keyboardviz

Quick Start

from keyboardviz import generate_keyboard

# Define your key mappings
mappings = {
    "w": "Pen", 
    "<Shift>w": "Laser", 
    "f": "Highlighter", 
    "<Alt>d": "Tool"
}

# Generate keyboard visualization
generate_keyboard(
    mappings, 
    export_svg="my_keyboard.svg", 
    export_png="my_keyboard.png"
)

Key Mapping Format

  • Normal keys: "a": "Action"
  • Shift modifier: "<Shift>a": "Shift Action"
  • Ctrl modifier: "<Ctrl>a": "Ctrl Action"
  • Alt modifier: "<Alt>a": "Alt Action"

Features

  • SVG and PNG export
  • Color-coded modifiers
  • Customizable colors and dimensions
  • Clean, minimal design

Example Image

docs/my_keyboard.svg

License

MIT

Metadata

Release files for keyboardviz 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for keyboardviz 1.0.0
File Size Uploaded
keyboardviz-1.0.0.tar.gz 5.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for keyboardviz 1.0.0
File Interpreter ABI Platform
keyboardviz-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 11.8 kB

Release files / keyboardviz-1.0.0.tar.gz

Download URL keyboardviz-1.0.0.tar.gz
Size 5.5 kB
Tags Source
SHA-256 checksum
How to use checksums
21d33157d2689930efb07a4d491462eb0f36bf2f0639793f150f904bdf4ac83b
BLAKE2b-256 checksum
How to use checksums
a86644c017141b7e17d437c7f5a3918662d82135fefadbb7e0ef35d69e2a47fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 10, 2025.

Transparency log

Release files / keyboardviz-1.0.0-py3-none-any.whl

Download URL keyboardviz-1.0.0-py3-none-any.whl
Size 6.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e357859166c8c317fab6f89c98dd8379a39a7c77c84b1bb310ea6e1b00ba2567
BLAKE2b-256 checksum
How to use checksums
d9289e278f06b9f8672ac58da1c360e0def54f4a9efcc6979f8854bf28a8258a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 10, 2025.

Transparency log

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page