[CLI] Add a subcommand for getting information about a keyboard #8666

skullydazed · 2020-04-03T21:58:28Z

This adds a new command, qmk info, that parses info.json and displays some information about the keyboard. You can specify the keyboard with -kb, by setting user.keyboard, or with the automagic_keyboard functionality.

You can also render the layouts in various ways:

-l Show all the layouts with info.json labels
-m Show all the layouts with matrix positions
-km <keymap> Show the layers for a JSON keymap

Types of Changes

Core
New feature

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

skullydazed · 2020-04-07T21:05:41Z

Showing the command in action

Basic info in text format

Matrix and Keymap printing

Layout printing

Erovia · 2020-04-12T12:04:12Z

lib/python/qmk/constants.py

+# Supported processor types
+ARM_PROCESSORS = 'cortex-m0', 'cortex-m0plus', 'cortex-m3', 'cortex-m4', 'MKL26Z64', 'MK20DX128', 'MK20DX256', 'STM32F042', 'STM32F072', 'STM32F103', 'STM32F303'
+AVR_PROCESSORS = 'at90usb1286', 'at90usb646', 'atmega16u2', 'atmega328p', 'atmega32a', 'atmega32u2', 'atmega32u4', None
+ALL_PROCESSORS = ARM_PROCESSORS + AVR_PROCESSORS
+VUSB_PROCESSORS = 'atmega328p', 'atmega32a'


Just a note to myself, that this well need to merged somehow with
https://github.com/noroadsleft/qmk_firmware/blob/feature/arm_template/lib/python/qmk/constants.py

skullydazed · 2020-04-19T19:14:56Z

CI failure is unrelated, same error occurs on master for handwired/onekey/pytest:rgb.

skullydazed · 2020-04-19T19:15:17Z

This should be ready to go now.

Erovia

I tried to be thorough, but I'm sure I've missed a few things here and there given the size of this PR.
Overall, very handy feature.

Note: I think this subcommand would benefit from #8817, in order to be able to provide similar output for C keymaps, as it does now for JSON keymaps.

lib/python/qmk/makefile.py

lib/python/qmk/path.py

lib/python/qmk/tests/test_cli_commands.py

lib/python/qmk/keymap.py

lib/python/qmk/c_parse.py

lib/python/qmk/keyboard.py

skullydazed · 2020-05-17T19:52:00Z

All feedback should have been addressed and I've rebased on master.

Erovia

I believe these are the last ones.
Fixed the broken list-keymap and some other things.
The checks should be all green with the suggestions.

lib/python/qmk/c_parse.py

lib/python/qmk/keymap.py

lib/python/qmk/cli/list/keymaps.py

lib/python/qmk/keymap.py

lib/python/qmk/tests/test_cli_commands.py

keyboards/handwired/onekey/pytest/keymaps/default/keymap.json

Co-authored-by: Erovia <Erovia@users.noreply.github.com>

[CLI] Add a subcommand for getting information about a keyboard

* upstream/master: (800 commits) Fix crkbd slave matrix print to require debug_matrix (qmk#9217) Keyboards/zsa updates (qmk#9214) Community layout support for KBDpad Mk.I (qmk#9220) Fix projectkb/alice LED indicator (qmk#9226) RSTHD keymap for Minidox (qmk#9178) Fix running qmk info without any arguments (qmk#9218) [Keymap] Update yttyx Planck keymap (qmk#9191) Documentation for keymap_extras (qmk#9194) Adding TGR Tris/Tris CE Numpad (qmk#9139) ISSI driver compile error fix (qmk#9169) Fix the path for generated keymaps (qmk#9213) Fix compiling json files (qmk#9210) [CLI] Add a subcommand for getting information about a keyboard (qmk#8666) [Keymap] Contributing Home-Row-Centric-Mousekey Layout (qmk#9195) CLI: fix `json2c` subcommand and add/fix tests (qmk#9206) [Keymap] Ported ok60 to via (qmk#9179) [Docs] Japanese translation of docs/feature_pointing_device.md (qmk#8993) [Keymap] Niu keymap and README update (qmk#9190) [Keyboard] Add Key 65 by Fox Lab (qmk#9116) [Keymap] update helix/rev2:yshrsmz keymap (qmk#9047) ...

…8666) You can now use `qmk info` to get information about keyboards and keymaps. Co-authored-by: Erovia <Erovia@users.noreply.github.com>

skullydazed added python cli qmk cli command labels Apr 3, 2020

skullydazed requested a review from a team April 3, 2020 21:58

skullydazed force-pushed the qmk_info branch from 650138a to 9b03c8f Compare April 4, 2020 20:56

drashna requested a review from Erovia April 5, 2020 06:23

skullydazed force-pushed the qmk_info branch from 3337c18 to 032975f Compare April 7, 2020 20:15

skullydazed marked this pull request as ready for review April 7, 2020 21:01

Erovia reviewed Apr 12, 2020

View reviewed changes

skullydazed force-pushed the qmk_info branch from 0653182 to 958fe39 Compare April 18, 2020 18:27

skullydazed requested a review from a team April 19, 2020 19:15

skullydazed force-pushed the qmk_info branch from 032d2a9 to 9e43e84 Compare April 19, 2020 22:18

skullydazed force-pushed the qmk_info branch from 9e43e84 to e8aa877 Compare April 30, 2020 00:25

skullydazed mentioned this pull request May 9, 2020

add argument to qmk compile to build compile_commands.json for you #8916

Closed

13 tasks

Erovia requested changes May 17, 2020

View reviewed changes

skullydazed commented May 17, 2020

View reviewed changes

lib/python/qmk/keyboard.py Outdated Show resolved Hide resolved

skullydazed force-pushed the qmk_info branch from a0ee90d to 61b840e Compare May 17, 2020 19:50

skullydazed requested a review from a team May 17, 2020 19:51

Erovia requested changes May 22, 2020

View reviewed changes

Erovia requested a review from a team May 22, 2020 17:10

Erovia reviewed May 26, 2020

View reviewed changes

keyboards/handwired/onekey/pytest/keymaps/default/keymap.json Outdated Show resolved Hide resolved

skullydazed added 6 commits May 26, 2020 09:05

initial version of qmk info

c35d1e5

Add layout rendering

7c0b8e3

pyformat and pytest

8104cc2

back out the milc change

3b140c3

make flake8 happy

5298e4d

actually make flake8 happy

d8f84c4

skullydazed and others added 6 commits May 26, 2020 09:06

fix title_caps in show_layouts()

a7c2929

update parse_rules_mk

43c40eb

Update lib/python/qmk/keyboard.py

d8b60c0

remove print_stdout_if_error

53d9b6d

change y to 0 for keyboards without an info.json

0160bd9

move to the default_json keymap

48320bd

skullydazed force-pushed the qmk_info branch from e1685ef to 48320bd Compare May 26, 2020 16:13

skullydazed and others added 4 commits May 26, 2020 09:41

sort out the is_keymap_dir stuff

4641a58

Apply suggestions from code review

7d7db29

Co-authored-by: Erovia <Erovia@users.noreply.github.com>

fixup tests

61c8dc4

use check_returncode() in more places

16df5ad

zvecr added a commit to zvecr/qmk_firmware that referenced this pull request May 26, 2020

Merge pull request qmk#8666 from qmk/qmk_info

aa3f024

[CLI] Add a subcommand for getting information about a keyboard

Erovia approved these changes May 26, 2020

View reviewed changes

skullydazed merged commit 751316c into master May 26, 2020

skullydazed deleted the qmk_info branch May 26, 2020 20:05

skullydazed mentioned this pull request May 26, 2020

Fix compiling json files #9210

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CLI] Add a subcommand for getting information about a keyboard #8666

[CLI] Add a subcommand for getting information about a keyboard #8666

skullydazed commented Apr 3, 2020 •

edited

Loading

skullydazed commented Apr 7, 2020

Erovia Apr 12, 2020 •

edited

Loading

skullydazed commented Apr 19, 2020

skullydazed commented Apr 19, 2020

Erovia left a comment

skullydazed commented May 17, 2020

Erovia left a comment

[CLI] Add a subcommand for getting information about a keyboard #8666

[CLI] Add a subcommand for getting information about a keyboard #8666

Conversation

skullydazed commented Apr 3, 2020 • edited Loading

Types of Changes

Checklist

skullydazed commented Apr 7, 2020

Showing the command in action

Basic info in text format

Matrix and Keymap printing

Layout printing

Erovia Apr 12, 2020 • edited Loading

Choose a reason for hiding this comment

skullydazed commented Apr 19, 2020

skullydazed commented Apr 19, 2020

Erovia left a comment

Choose a reason for hiding this comment

skullydazed commented May 17, 2020

Erovia left a comment

Choose a reason for hiding this comment

skullydazed commented Apr 3, 2020 •

edited

Loading

Erovia Apr 12, 2020 •

edited

Loading