Skip to main content

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

Project description

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

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

keyboardviz-1.0.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

keyboardviz-1.0.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file keyboardviz-1.0.0.tar.gz.

File metadata

  • Download URL: keyboardviz-1.0.0.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for keyboardviz-1.0.0.tar.gz
Algorithm Hash digest
SHA256 21d33157d2689930efb07a4d491462eb0f36bf2f0639793f150f904bdf4ac83b
MD5 4c26da4487198bb98eb797f9e34772dc
BLAKE2b-256 a86644c017141b7e17d437c7f5a3918662d82135fefadbb7e0ef35d69e2a47fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for keyboardviz-1.0.0.tar.gz:

Publisher: publish.yml on youssefadly237/keyboardviz

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file keyboardviz-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: keyboardviz-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for keyboardviz-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e357859166c8c317fab6f89c98dd8379a39a7c77c84b1bb310ea6e1b00ba2567
MD5 f9d871a7aef901b4b2234f48086d611d
BLAKE2b-256 d9289e278f06b9f8672ac58da1c360e0def54f4a9efcc6979f8854bf28a8258a

See more details on using hashes here.

Provenance

The following attestation bundles were made for keyboardviz-1.0.0-py3-none-any.whl:

Publisher: publish.yml on youssefadly237/keyboardviz

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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