Skip to content

monokuroumu/kmk_firmware

This branch is 664 commits behind KMKfw/kmk_firmware:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

4d1f9e4 · Mar 6, 2022
Sep 14, 2021
Mar 2, 2022
Mar 6, 2022
Oct 5, 2021
Mar 6, 2022
Feb 14, 2022
Jan 29, 2022
Jul 25, 2019
Oct 12, 2018
Mar 4, 2022
Jul 25, 2019
Jun 20, 2021
Dec 29, 2018
Feb 4, 2022
Jun 20, 2021
Jan 25, 2022
Feb 1, 2022
Jun 20, 2021
Jun 20, 2021
Jun 20, 2021
Jun 20, 2021
Jun 20, 2021

Repository files navigation

KMK: Clackety Keyboards Powered by Python

GitHubGitHub contributorsDiscordLines of codeGitHub issuesGitHub closed issues

KMK is a feature-rich and beginner-friendly firmware for computer keyboards written and configured in CircuitPython.

KMK is currently looking for maintainers. If you like keyboards and/or Python, and ideally have contributed to KMK in the past, and are interested in (co-)maintaining KMK, comment on the relevant GitHub issue or drop by the Matrix channel below.

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.

Features

Getting Started

Our getting started guide can be found here

The KMK Team

KMK was originally authored by @klardotsh and @kdb424 over the winter of 2018-19, and has been contributed to by numerous others since. 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. A list of KMK's contributors can be found on GitHub.

While Adafruit employees and affiliates are occasionally found in the commit log 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).

Tests

Unit tests within the tests folder mock various CicuitPython modules to allow them to be executed in a desktop development environment.

Execute tests using the command python -m unittest.

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.

About

Clackety Keyboards Powered by Python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.4%
  • Makefile 1.1%
  • Other 0.5%