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 capylayer

Usage

  1. Add profiles in capylayer/models/config/profiles.json (TUI is not implemented currently)

  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.1.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.1-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: capylayer-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 2163facd27fde3250ff5e49d4b4850157f0f5951a8a6a96255e4f28006ea8fd3
MD5 f97fcd1946fe2d89f5a629ae86a7bf39
BLAKE2b-256 f53bb3aacc5d2edafc544bb48b547a84eede2f0bc383ab9390cfa27fb35b97a2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: capylayer-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 047d21824c9913ec1e46af5328fb6ccbdddea1625f24a6fa911e6347de461948
MD5 fb81832b3d20ad6d5062dfb141a479fb
BLAKE2b-256 070cd9c1acd32d68adf1e87c1f6a925a7252d3def79b0a2319d4833eb95cb3b0

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