diff options
author | Joel Challis <git@zvecr.com> | 2022-07-02 12:50:09 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-07-02 21:50:09 +1000 |
commit | 59e28b8958db4940f026c4bbd81dee7b9b5e49b0 (patch) | |
tree | c9c8ba26fdef7a47e640ee34d22fd1199e0c669e /lib/python/qmk/cli/import/kbfirmware.py | |
parent | 9dc7b9d40cfa199875cdc9e2e05b15d3f463b415 (diff) | |
download | qmk_firmware-59e28b8958db4940f026c4bbd81dee7b9b5e49b0.tar.gz qmk_firmware-59e28b8958db4940f026c4bbd81dee7b9b5e49b0.zip |
Add cli command to import keyboard|keymap|kbfirmware (#16668)
Diffstat (limited to 'lib/python/qmk/cli/import/kbfirmware.py')
-rw-r--r-- | lib/python/qmk/cli/import/kbfirmware.py | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/import/kbfirmware.py b/lib/python/qmk/cli/import/kbfirmware.py new file mode 100644 index 0000000000..9c03737378 --- /dev/null +++ b/lib/python/qmk/cli/import/kbfirmware.py @@ -0,0 +1,25 @@ +from milc import cli + +from qmk.importers import import_kbfirmware as _import_kbfirmware +from qmk.path import FileType +from qmk.json_schema import json_load + + +@cli.argument('filename', type=FileType('r'), nargs='+', arg_only=True, help='file') +@cli.subcommand('Import kbfirmware json export') +def import_kbfirmware(cli): + filename = cli.args.filename[0] + + data = json_load(filename) + + cli.log.info(f'{{style_bright}}Importing {filename.name}.{{style_normal}}') + cli.echo('') + + cli.log.warn("Support here is basic - Consider using 'qmk new-keyboard' instead") + + kb_name = _import_kbfirmware(data) + + cli.log.info(f'{{fg_green}}Imported a new keyboard named {{fg_cyan}}{kb_name}{{fg_green}}.{{fg_reset}}') + cli.log.info(f'To start working on things, `cd` into {{fg_cyan}}keyboards/{kb_name}{{fg_reset}},') + cli.log.info('or open the directory in your preferred text editor.') + cli.log.info(f"And build with {{fg_yellow}}qmk compile -kb {kb_name} -km default{{fg_reset}}.") |