diff options
author | skullydazed <skullydazed@users.noreply.github.com> | 2019-09-22 13:25:33 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-09-22 13:25:33 -0700 |
commit | d569f0877155efc752994f8a21f5cf001f9d6ae6 (patch) | |
tree | eb58a3e3f916d6d938d8f05742d48919c053a579 /lib/python/qmk/cli/new/keymap.py | |
parent | 2f49cae9bcbdd94431659727ef75cfd30f557da8 (diff) | |
download | qmk_firmware-d569f0877155efc752994f8a21f5cf001f9d6ae6.tar.gz qmk_firmware-d569f0877155efc752994f8a21f5cf001f9d6ae6.zip |
Configuration system for CLI (#6708)
* Rework how bin/qmk handles subcommands
* qmk config wip
* Code to show all configs
* Fully working `qmk config` command
* Mark some CLI arguments so they don't pollute the config file
* Fleshed out config support, nicer subcommand support
* sync with installable cli
* pyformat
* Add a test for subcommand_modules
* Documentation for the `qmk config` command
* split config_token on space so qmk config is more predictable
* Rework how subcommands are imported
* Document `arg_only`
* Document deleting from CLI
* Document how multiple operations work
* Add cli config to the doc index
* Add tests for the cli commands
* Make running the tests more reliable
* Be more selective about building all default keymaps
* Update new-keymap to fit the new subcommand style
* Add documentation about writing CLI scripts
* Document new-keyboard
* Update docs/cli_configuration.md
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Update docs/cli_development.md
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Update docs/cli_development.md
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Update docs/cli_development.md
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Address yan's comments.
* Apply suggestions from code review
suggestions from @noahfrederick
Co-Authored-By: Noah Frederick <code@noahfrederick.com>
* Apply suggestions from code review
Co-Authored-By: Noah Frederick <code@noahfrederick.com>
* Remove pip3 from the test runner
Diffstat (limited to 'lib/python/qmk/cli/new/keymap.py')
-rwxr-xr-x | lib/python/qmk/cli/new/keymap.py | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/lib/python/qmk/cli/new/keymap.py b/lib/python/qmk/cli/new/keymap.py index b378e5ab4..5efb81c93 100755 --- a/lib/python/qmk/cli/new/keymap.py +++ b/lib/python/qmk/cli/new/keymap.py | |||
@@ -6,15 +6,15 @@ import shutil | |||
6 | from milc import cli | 6 | from milc import cli |
7 | 7 | ||
8 | 8 | ||
9 | @cli.argument('-k', '--keyboard', help='Specify keyboard name. Example: 1upkeyboards/1up60hse') | 9 | @cli.argument('-kb', '--keyboard', help='Specify keyboard name. Example: 1upkeyboards/1up60hse') |
10 | @cli.argument('-u', '--username', help='Specify any name for the new keymap directory') | 10 | @cli.argument('-km', '--keymap', help='Specify the name for the new keymap directory') |
11 | @cli.entrypoint('Creates a new keymap for the keyboard of your choosing') | 11 | @cli.subcommand('Creates a new keymap for the keyboard of your choosing') |
12 | def main(cli): | 12 | def new_keymap(cli): |
13 | """Creates a new keymap for the keyboard of your choosing. | 13 | """Creates a new keymap for the keyboard of your choosing. |
14 | """ | 14 | """ |
15 | # ask for user input if keyboard or username was not provided in the command line | 15 | # ask for user input if keyboard or username was not provided in the command line |
16 | keyboard = cli.config.general.keyboard if cli.config.general.keyboard else input("Keyboard Name: ") | 16 | keyboard = cli.config.new_keymap.keyboard if cli.config.new_keymap.keyboard else input("Keyboard Name: ") |
17 | username = cli.config.general.username if cli.config.general.username else input("Username: ") | 17 | keymap = cli.config.new_keymap.keymap if cli.config.new_keymap.keymap else input("Keymap Name: ") |
18 | 18 | ||
19 | # generate keymap paths | 19 | # generate keymap paths |
20 | kb_path = os.path.join(os.getcwd(), "keyboards", keyboard) | 20 | kb_path = os.path.join(os.getcwd(), "keyboards", keyboard) |
@@ -36,6 +36,5 @@ def main(cli): | |||
36 | shutil.copytree(keymap_path_default, keymap_path, symlinks=True) | 36 | shutil.copytree(keymap_path_default, keymap_path, symlinks=True) |
37 | 37 | ||
38 | # end message to user | 38 | # end message to user |
39 | cli.log.info("%s keymap directory created in: %s\n" + | 39 | cli.log.info("%s keymap directory created in: %s", username, keymap_path) |
40 | "Compile a firmware file with your new keymap by typing: \n" + | 40 | cli.log.info("Compile a firmware with your new keymap by typing: \n" + "qmk compile -kb %s -km %s", keyboard, username) |
41 | "qmk compile -kb %s -km %s", username, keymap_path, keyboard, username) | ||