qmk_firmware/lib/python/qmk/cli/list/keymaps.py
Erovia 26f53d38d9 Another major refactoring, add documentation
Move all useful functions to the qmk module and use the cli subcommand
as a wrapper around it.
Add both inline comments and documentation.
2020-02-15 15:19:03 -08:00

21 lines
841 B
Python

"""List the keymaps for a specific keyboard
"""
from milc import cli
import qmk.keymap
from qmk.errors import NoSuchKeyboardError
@cli.argument("-kb", "--keyboard", help="Specify keyboard name. Example: 1upkeyboards/1up60hse")
@cli.subcommand("List the keymaps for a specific keyboard")
def list_keymaps(cli):
"""List the keymaps for a specific keyboard
"""
# ask for user input if keyboard was not provided in the command line
keyboard_name = cli.config.list_keymaps.keyboard if cli.config.list_keymaps.keyboard else input("Keyboard Name: ")
try:
for name in qmk.keymap.list_keymaps(keyboard_name):
# We echo instead of cli.log.info to allow easier piping of this output
cli.echo(keyboard_name + ":" + name)
except NoSuchKeyboardError as e:
cli.echo("{fg_red}" + e.message)