diff options
-rwxr-xr-x | bin/qmk | 2 | ||||
-rw-r--r-- | docs/cli.md | 17 | ||||
-rwxr-xr-x | lib/python/qmk/cli/compile.py | 53 | ||||
-rw-r--r-- | lib/python/qmk/cli/compile/__init__.py | 0 | ||||
-rwxr-xr-x | lib/python/qmk/cli/compile/json.py | 44 |
5 files changed, 66 insertions, 50 deletions
@@ -38,7 +38,7 @@ with open('requirements.txt', 'r') as fd: | |||
38 | 38 | ||
39 | # Figure out our version | 39 | # Figure out our version |
40 | command = ['git', 'describe', '--abbrev=6', '--dirty', '--always', '--tags'] | 40 | command = ['git', 'describe', '--abbrev=6', '--dirty', '--always', '--tags'] |
41 | result = subprocess.run(command, universal_newlines=True, capture_output=True) | 41 | result = subprocess.run(command, universal_newlines=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
42 | 42 | ||
43 | if result.returncode == 0: | 43 | if result.returncode == 0: |
44 | os.environ['QMK_VERSION'] = 'QMK ' + result.stdout.strip() | 44 | os.environ['QMK_VERSION'] = 'QMK ' + result.stdout.strip() |
diff --git a/docs/cli.md b/docs/cli.md index 0365f2c9c..1843f42cd 100644 --- a/docs/cli.md +++ b/docs/cli.md | |||
@@ -6,7 +6,8 @@ This page describes how to setup and use the QMK CLI. | |||
6 | 6 | ||
7 | The QMK CLI makes building and working with QMK keyboards easier. We have provided a number of commands to help you work with QMK: | 7 | The QMK CLI makes building and working with QMK keyboards easier. We have provided a number of commands to help you work with QMK: |
8 | 8 | ||
9 | * `qmk compile-json` | 9 | * `qmk compile` |
10 | * `qmk doctor` | ||
10 | 11 | ||
11 | # Setup | 12 | # Setup |
12 | 13 | ||
@@ -20,12 +21,18 @@ You may want to add this to your `.profile`, `.bash_profile`, `.zsh_profile`, or | |||
20 | 21 | ||
21 | # Commands | 22 | # Commands |
22 | 23 | ||
23 | ## `qmk compile-json` | 24 | ## `qmk compile` |
24 | 25 | ||
25 | This command allows you to compile JSON files you have downloaded from <https://config.qmk.fm>. | 26 | This command allows you to compile firmware from any directory. You can compile JSON exports from <https://config.qmk.fm> or compile keymaps in the repo. |
26 | 27 | ||
27 | **Usage**: | 28 | **Usage for Configurator Exports**: |
28 | 29 | ||
29 | ``` | 30 | ``` |
30 | qmk compile-json mine.json | 31 | qmk compile <configuratorExport.json> |
32 | ``` | ||
33 | |||
34 | **Usage for Keymaps**: | ||
35 | |||
36 | ``` | ||
37 | qmk compile -kb <keyboard_name> -km <keymap_name> | ||
31 | ``` | 38 | ``` |
diff --git a/lib/python/qmk/cli/compile.py b/lib/python/qmk/cli/compile.py new file mode 100755 index 000000000..7e14ad8fb --- /dev/null +++ b/lib/python/qmk/cli/compile.py | |||
@@ -0,0 +1,53 @@ | |||
1 | """Compile a QMK Firmware. | ||
2 | |||
3 | You can compile a keymap already in the repo or using a QMK Configurator export. | ||
4 | """ | ||
5 | import json | ||
6 | import os | ||
7 | import sys | ||
8 | import subprocess | ||
9 | from argparse import FileType | ||
10 | |||
11 | from milc import cli | ||
12 | |||
13 | import qmk.keymap | ||
14 | import qmk.path | ||
15 | |||
16 | |||
17 | @cli.argument('filename', nargs='?', type=FileType('r'), help='The configurator export to compile') | ||
18 | @cli.argument('-kb', '--keyboard', help='The keyboard to build a firmware for. Ignored when a configurator export is supplied.') | ||
19 | @cli.argument('-km', '--keymap', help='The keymap to build a firmware for. Ignored when a configurator export is supplied.') | ||
20 | @cli.entrypoint('Compile a QMK Firmware.') | ||
21 | def main(cli): | ||
22 | """Compile a QMK Firmware. | ||
23 | |||
24 | If a Configurator export is supplied this command will create a new keymap, overwriting an existing keymap if one exists. | ||
25 | |||
26 | FIXME(skullydazed): add code to check and warn if the keymap already exists | ||
27 | |||
28 | If --keyboard and --keymap are provided this command will build a firmware based on that. | ||
29 | |||
30 | """ | ||
31 | if cli.args.filename: | ||
32 | # Parse the configurator json | ||
33 | user_keymap = json.load(cli.args.filename) | ||
34 | |||
35 | # Generate the keymap | ||
36 | keymap_path = qmk.path.keymap(user_keymap['keyboard']) | ||
37 | cli.log.info('Creating {fg_cyan}%s{style_reset_all} keymap in {fg_cyan}%s', user_keymap['keymap'], keymap_path) | ||
38 | qmk.keymap.write(user_keymap['keyboard'], user_keymap['keymap'], user_keymap['layout'], user_keymap['layers']) | ||
39 | cli.log.info('Wrote keymap to {fg_cyan}%s/%s/keymap.c', keymap_path, user_keymap['keymap']) | ||
40 | |||
41 | # Compile the keymap | ||
42 | command = ['make', ':'.join((user_keymap['keyboard'], user_keymap['keymap']))] | ||
43 | |||
44 | elif cli.config.general.keyboard and cli.config.general.keymap: | ||
45 | # Generate the make command for a specific keyboard/keymap. | ||
46 | command = ['make', ':'.join((cli.config.general.keyboard, cli.config.general.keymap))] | ||
47 | |||
48 | else: | ||
49 | cli.log.error('You must supply a configurator export or both `--keyboard` and `--keymap`.') | ||
50 | return False | ||
51 | |||
52 | cli.log.info('Compiling keymap with {fg_cyan}%s\n\n', ' '.join(command)) | ||
53 | subprocess.run(command) | ||
diff --git a/lib/python/qmk/cli/compile/__init__.py b/lib/python/qmk/cli/compile/__init__.py deleted file mode 100644 index e69de29bb..000000000 --- a/lib/python/qmk/cli/compile/__init__.py +++ /dev/null | |||
diff --git a/lib/python/qmk/cli/compile/json.py b/lib/python/qmk/cli/compile/json.py deleted file mode 100755 index 89c16b206..000000000 --- a/lib/python/qmk/cli/compile/json.py +++ /dev/null | |||
@@ -1,44 +0,0 @@ | |||
1 | """Create a keymap directory from a configurator export. | ||
2 | """ | ||
3 | import json | ||
4 | import os | ||
5 | import sys | ||
6 | import subprocess | ||
7 | |||
8 | from milc import cli | ||
9 | |||
10 | import qmk.keymap | ||
11 | import qmk.path | ||
12 | |||
13 | |||
14 | @cli.argument('filename', help='Configurator JSON export') | ||
15 | @cli.entrypoint('Compile a QMK Configurator export.') | ||
16 | def main(cli): | ||
17 | """Compile a QMK Configurator export. | ||
18 | |||
19 | This command creates a new keymap from a configurator export, overwriting an existing keymap if one exists. | ||
20 | |||
21 | FIXME(skullydazed): add code to check and warn if the keymap already exists | ||
22 | """ | ||
23 | # Error checking | ||
24 | if cli.args.filename == ('-'): | ||
25 | cli.log.error('Reading from STDIN is not (yet) supported.') | ||
26 | exit(1) | ||
27 | if not os.path.exists(qmk.path.normpath(cli.args.filename)): | ||
28 | cli.log.error('JSON file does not exist!') | ||
29 | exit(1) | ||
30 | |||
31 | # Parse the configurator json | ||
32 | with open(qmk.path.normpath(cli.args.filename), 'r') as fd: | ||
33 | user_keymap = json.load(fd) | ||
34 | |||
35 | # Generate the keymap | ||
36 | keymap_path = qmk.path.keymap(user_keymap['keyboard']) | ||
37 | cli.log.info('Creating {fg_cyan}%s{style_reset_all} keymap in {fg_cyan}%s', user_keymap['keymap'], keymap_path) | ||
38 | qmk.keymap.write(user_keymap['keyboard'], user_keymap['keymap'], user_keymap['layout'], user_keymap['layers']) | ||
39 | cli.log.info('Wrote keymap to {fg_cyan}%s/%s/keymap.c', keymap_path, user_keymap['keymap']) | ||
40 | |||
41 | # Compile the keymap | ||
42 | command = ['make', ':'.join((user_keymap['keyboard'], user_keymap['keymap']))] | ||
43 | cli.log.info('Compiling keymap with {fg_cyan}%s\n\n', ' '.join(command)) | ||
44 | subprocess.run(command) | ||