qmk-skim 0.5.2

Svalboard Keymap Image Maker

qmk-skim (Svalboard Keymap Image Maker)

A Python CLI tool for generating high-quality keymap layout images for the Svalboard keyboard.

Features

• Generate individual layer keymap images
• Generate overview images showing all layers
• Support for multiple keymap formats:
  • Keybard (.kbi)
  • Vial (.vil)
  • QMK c2json (.json)
• Configurable colors and appearance
• High-quality output in multiple formats:
  • Vector: SVG
  • Raster: PNG, JPEG, WEBP, AVIF

Installation

You can install qmk-skim using pip, pipx, or uv.

Using uv (Recommended)

uv tool install qmk-skim

Using pipx

pipx install qmk-skim

Using pip

pip install qmk-skim

Usage

The package installs the skim command-line tool.

Generate keymap images

# Generate from a keymap file
skim generate --keymap my-keymap.kbi --output-dir ./images

# Generate with custom configuration
skim generate --keymap my-keymap.kbi --config skim-config.yaml --output-dir ./images

# Generate specific layers only
skim generate --keymap my-keymap.kbi --layer 1 --layer 3-5 --layer overview

Configuration helper

# Create a configuration file from QMK color.h
skim configure --qmk-color-header /path/to/qmk/quantum/color.h --output skim-config.yaml

Development

This project uses uv for dependency management and just as a command runner.

Setup

# Clone the repository
git clone https://github.com/Townk/skim.git
cd skim

# Install dependencies
just sync

Testing

# Run all tests (unit + integration)
just tests

# Run only unit tests
just unit-tests

# Run only integration tests
just integration-tests

Code Quality

Run the full suite of checks (linting, formatting, type checking) before submitting a PR:

just check

Individual checks:

just lint      # Run ruff linter
just format    # Format code with ruff
just typecheck # Run basedpyright

Building Documentation

just build-docs

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.