diff options
Diffstat (limited to 'lib/python/qmk/cli/new/keymap.py')
-rwxr-xr-x | lib/python/qmk/cli/new/keymap.py | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/new/keymap.py b/lib/python/qmk/cli/new/keymap.py new file mode 100755 index 000000000..b378e5ab4 --- /dev/null +++ b/lib/python/qmk/cli/new/keymap.py | |||
@@ -0,0 +1,41 @@ | |||
1 | """This script automates the copying of the default keymap into your own keymap. | ||
2 | """ | ||
3 | import os | ||
4 | import shutil | ||
5 | |||
6 | from milc import cli | ||
7 | |||
8 | |||
9 | @cli.argument('-k', '--keyboard', help='Specify keyboard name. Example: 1upkeyboards/1up60hse') | ||
10 | @cli.argument('-u', '--username', help='Specify any name for the new keymap directory') | ||
11 | @cli.entrypoint('Creates a new keymap for the keyboard of your choosing') | ||
12 | def main(cli): | ||
13 | """Creates a new keymap for the keyboard of your choosing. | ||
14 | """ | ||
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: ") | ||
17 | username = cli.config.general.username if cli.config.general.username else input("Username: ") | ||
18 | |||
19 | # generate keymap paths | ||
20 | kb_path = os.path.join(os.getcwd(), "keyboards", keyboard) | ||
21 | keymap_path_default = os.path.join(kb_path, "keymaps/default") | ||
22 | keymap_path = os.path.join(kb_path, "keymaps/%s" % username) | ||
23 | |||
24 | # check directories | ||
25 | if not os.path.exists(kb_path): | ||
26 | cli.log.error('Keyboard %s does not exist!', kb_path) | ||
27 | exit(1) | ||
28 | if not os.path.exists(keymap_path_default): | ||
29 | cli.log.error('Keyboard default %s does not exist!', keymap_path_default) | ||
30 | exit(1) | ||
31 | if os.path.exists(keymap_path): | ||
32 | cli.log.error('Keymap %s already exists!', keymap_path) | ||
33 | exit(1) | ||
34 | |||
35 | # create user directory with default keymap files | ||
36 | shutil.copytree(keymap_path_default, keymap_path, symlinks=True) | ||
37 | |||
38 | # end message to user | ||
39 | cli.log.info("%s keymap directory created in: %s\n" + | ||
40 | "Compile a firmware file with your new keymap by typing: \n" + | ||
41 | "qmk compile -kb %s -km %s", username, keymap_path, keyboard, username) | ||