Skip to main content

Create key layers to your keyboard

Project description

capylayer

A simple Python tool to create key layers activated by modifier hotkeys.

Capylayer allows you to remap specified keys to build layers for your keyboard. Layers are activated by modifier hotkeys and are contained in profiles. You can build layouts like QWERTY, Colemak, Dvorak, a symbol layer, or any other useful remapping.

Modifier mode

A modifier hotkey can be set to one of two modes:

  • Switch: Temporarily activate a layer by holding the modifier hotkey, similar to Shift.
  • Lock: Toggle a layer on/off by pressing the modifier hotkey, similar to CapsLock.

Example

Profile: "capy"

  • Key Layer:
    • Modifier hotkey: CapsLock
    • Modifier mode: Switch
    • Key remaps:
      • adelete
      • sf1
      • dup

While CapsLock is held, the key layer is active:

                     _____  _____  _____ 
                    /\ del \\  f1 \\  ↑  \ 
                    \ \_____\\_____\\_____\
                     \/_____//_____//_____/
                      /      /      / 
                  ___/_  ___/_  ___/_   
    __________   /\  a  \\  s  \\  d  \     
   \  CapsLock \ \ \_____\\_____\\_____\    
    \___________\ \/_____//_____//_____/  

Installation

  1. Install via pip:
pip install git+https://github.com/figdavi/capylayer.git

Usage

  1. Add profiles in capylayer/models/config/profiles.json

  2. Then run:

capylayer

Future Improvements

  • Add a TUI with Textual
  • Design a way to check if key names exist as keys
  • Error logging
  • Implement support for key to symbol remapping
  • Create a pt-br README
  • Add dist files to repo

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

capylayer-0.1.0.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

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

capylayer-0.1.0-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file capylayer-0.1.0.tar.gz.

File metadata

  • Download URL: capylayer-0.1.0.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.5 Windows/10

File hashes

Hashes for capylayer-0.1.0.tar.gz
Algorithm Hash digest
SHA256 37c22c31280a6ec8538919a17c6bb5aacbe57d086d5355ed3eb7933d64956f4b
MD5 abd3786ac05458778b8fb0caa330d67e
BLAKE2b-256 071d611cafda6779bc45f3aa0fe68ffd63dee3a73a08373a03e775655a504658

See more details on using hashes here.

File details

Details for the file capylayer-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: capylayer-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.5 Windows/10

File hashes

Hashes for capylayer-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e592e4dc59817cec42a4f41c985f1de677389b7c7222ebbae660a96bfc081f4
MD5 5681b74cf109ce51321558103105a6ad
BLAKE2b-256 fc26c4ffc3a59746d8f7cf0199a9362b69485194bcf52ace528bdcac9cfe8d79

See more details on using hashes here.

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