https://github.com/pacjo/keycaplabelmaker

A quick `n easy keycap label maker made with python and qmk-like configuration files
https://github.com/pacjo/keycaplabelmaker

Last synced: about 2 months ago
JSON representation

A quick `n easy keycap label maker made with python and qmk-like configuration files

• Host: GitHub
• URL: https://github.com/pacjo/keycaplabelmaker
• Owner: pacjo
• License: gpl-3.0
• Created: 2023-08-16T17:44:16.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-02T11:03:59.000Z (over 2 years ago)
• Last Synced: 2024-04-17T23:57:09.581Z (about 2 years ago)
• Language: Python
• Homepage:
• Size: 15.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Keycap Label Maker

# Usage

> at the time of writing downloading *still* isn't implemented. As a workaround you can put all icons you want (svg or png) in the `icons` directory like this (for `mdi:desk-lamp` put your `desk-lamp.svg` or `desk-lamp.png` in `icons/mdi/`)

1. Create `.json` (qmk-like) configuration file (you can use `config.example.json` as a reference)

2. Install requirements with `pip install -r requirements.txt`

3. Run `python main.py .json`

4. your labels are in the `output` directory. (individual labels and grid image for printing)

# TODO

 - add optional front area (https://deskthority.net/wiki/Relegendable_key)

 - add downloading icons from:

   - material design icons (mdi) - https://pictogrammers.com/library/mdi/

   - fontawesome (fa) - https://fontawesome.com/

   - custom-brand-icons (phu) - https://github.com/elax46/custom-brand-icons

# File structure

generated with [tree](https://gitlab.com/nfriend/tree-online)

```

.

├── requirements.txt

├── main.py

├── config.example.json

└── (others, unneeded)/

    ├── icons/

    │   ├── mdi/

    │   │   └── svg/png files

    │   ├── phu/

    │   │   └── svg/png files

    │   ├── fa/

    │   │   └── svg/png files

    │   └── (others)/

    │       └── svg/png files

    └── output/

        ├── keycap_{number}.png - individual labels

        └── grid.png - all labels on a grid for printing

```