| .github/workflows | ||
| boards | ||
| docs | ||
| hardware | ||
| kmk | ||
| user_keymaps | ||
| util | ||
| .dockerignore | ||
| .gitignore | ||
| .s3cfg | ||
| boot.py | ||
| Dockerfile | ||
| LICENSE.md | ||
| Makefile | ||
| Pipfile | ||
| Pipfile.lock | ||
| pyproject.toml | ||
| README.md | ||
| setup.cfg | ||
KMK: Clackety Keyboards Powered by Python
KMK is a feature-rich and beginner-friendly firmware for computer keyboards written and configured in CircuitPython. KMK is currently in public beta, however should handle almost all workflows without major issues.
You can always find the latest releases on our CDN, in compiled and
optimized and raw, hackable text
file forms. These follow the
master branch here on GitHub.
If you need support with KMK or just want to say hi, find us in #kmkfw:klar.sh on Matrix. This channel is bridged to Discord here for convenience.
If you ask for help on chat or open a bug report, if possible please give us your commit SHA, found by running
from kmk.consts import KMK_RELEASE; print(KMK_RELEASE)in the REPL on your controller.
Features
- Fully configured through a single, easy to understand Python file that lives on a "flash-drive"-esque space on your microcontroller - edit on the go without DFU or other devtooling available!
- Single-piece or two-piece split keyboards are supported
- Chainable
keys such as
KC.LWIN(KC.L)to lock the screen on a Windows PC - Built-in unicode macros, including emojis
- RGB underglow and LED backlights
- One key can turn into many more based on how many times you tap it
- Bluetooth HID and split keyboards. No more wires.
Getting Started
Our getting started guide can be found here
The KMK Team
KMK is primarily written and maintained by @klardotsh and @kdb424, but contributions are welcome from all, whether it's in the form of code, documentation, hardware designs, feature ideas, or anything else that comes to mind. KMK's contributors and other helpers are listed alphabetically by username below (we'll try to keep this up to date!):
- Dan Halbert (@dhalbert)
- Elvis Pfützenreuter (@elvis-epx)
- Kyle Brown (@kdb424)
- Josh Klar (@klardotsh)
- Limor Fried (@ladyada)
- Ryan Karpinski (@rk463345)
- @siddacious
- Scott Shawcroft (@tannewt)
While Adafruit employees and affiliates are included in the above list and their help has been crucial to KMK's success, KMK is not an official Adafruit project, and the Core team is not compensated by Adafruit for its development.
Code Style
KMK uses Black with a Python 3.6 target and,
(controversially?) single quotes.
Further code styling is enforced with isort and flake8 with several plugins.
make fix-isort fix-formatting before a commit is a good idea, and CI will fail
if inbound code does not adhere to these formatting rules. Some exceptions are
found in setup.cfg loosening the rules in isolated cases, notably
user_keymaps (which is also not subject to Black formatting for reasons
documented in pyproject.toml).
License, Copyright, and Legal
All software in this repository is licensed under the GNU Public License, verison 3. All documentation and hardware designs are licensed under the Creative Commons Attribution-ShareAlike 4.0 license. Contributions to this repository must use these licenses unless otherwise agreed to by the Core team.