Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| b5e8aa4cac | |||
| 1c6d81fc3b | |||
| 0ffae74377 | |||
| cbe3ad0248 | |||
| 97689b53d7 | |||
| 054e071787 | |||
| 78e0fda2f0 | |||
| 9c6123483b | |||
| e851c8fcb5 |
@@ -1,5 +1,6 @@
|
|||||||
# QMK CLI
|
# QMK CLI
|
||||||
[](https://github.com/qmk/qmk_cli/actions?query=workflow%3A%22CLI+Setup%22)
|
[](https://github.com/qmk/qmk_cli/actions?query=workflow%3A%22CLI+Setup%22)
|
||||||
|
|
||||||
A program to help users work with [QMK Firmware](https://qmk.fm/).
|
A program to help users work with [QMK Firmware](https://qmk.fm/).
|
||||||
|
|
||||||
# Features
|
# Features
|
||||||
@@ -8,15 +9,17 @@ A program to help users work with [QMK Firmware](https://qmk.fm/).
|
|||||||
* Use `qmk clone` to pull down anyone's `qmk_firmware` fork
|
* Use `qmk clone` to pull down anyone's `qmk_firmware` fork
|
||||||
* Setup your build environment with `qmk setup`
|
* Setup your build environment with `qmk setup`
|
||||||
* Check that your environment is correctly setup with `qmk doctor`
|
* Check that your environment is correctly setup with `qmk doctor`
|
||||||
* Dispatches to `qmk_firmware/bin/qmk` for additional functionality:
|
* Integrates with your qmk_firmware for additional functionality:
|
||||||
* `qmk compile-json`
|
* `qmk c2json`
|
||||||
* More to come
|
* `qmk compile`
|
||||||
|
* `qmk flash`
|
||||||
|
* `qmk json2c`
|
||||||
|
* `qmk lint`
|
||||||
|
* `qmk new-keymap`
|
||||||
|
|
||||||
# Quickstart
|
# Quickstart
|
||||||
|
|
||||||
Full documentation: <https://docs.qmk.fm/#/tutorial>
|
|
||||||
|
|
||||||
Basic steps:
|
|
||||||
|
|
||||||
* `python3 -m pip install qmk`
|
* `python3 -m pip install qmk`
|
||||||
* `qmk setup`
|
* `qmk setup`
|
||||||
|
|
||||||
|
Full documentation: <https://docs.qmk.fm/#/tutorial>
|
||||||
|
|||||||
+1
-1
@@ -1,3 +1,3 @@
|
|||||||
"""A program to help you work with qmk_firmware."""
|
"""A program to help you work with qmk_firmware."""
|
||||||
|
|
||||||
__version__ = '0.0.43'
|
__version__ = '0.0.46'
|
||||||
|
|||||||
@@ -3,4 +3,5 @@
|
|||||||
We list each subcommand here explicitly because all the reliable ways of searching for modules are slow and delay startup.
|
We list each subcommand here explicitly because all the reliable ways of searching for modules are slow and delay startup.
|
||||||
"""
|
"""
|
||||||
from . import clone # noqa
|
from . import clone # noqa
|
||||||
|
from . import env # noqa
|
||||||
from . import setup # noqa
|
from . import setup # noqa
|
||||||
|
|||||||
@@ -0,0 +1,30 @@
|
|||||||
|
"""Prints environment information.
|
||||||
|
"""
|
||||||
|
import os
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from milc import cli
|
||||||
|
from qmk_cli.helpers import is_qmk_firmware
|
||||||
|
|
||||||
|
|
||||||
|
@cli.argument('var', default=None, nargs='?', help='Optional variable to query')
|
||||||
|
@cli.subcommand('Prints environment information.')
|
||||||
|
def env(cli):
|
||||||
|
home = os.environ.get('QMK_HOME', "")
|
||||||
|
data = {
|
||||||
|
'QMK_HOME': home,
|
||||||
|
'QMK_FIRMWARE': home if is_qmk_firmware(Path(home)) else ""
|
||||||
|
}
|
||||||
|
|
||||||
|
# Now munge the current cli config
|
||||||
|
for key, val in cli.config.general.items():
|
||||||
|
converted_key = 'QMK_' + key.upper()
|
||||||
|
data[converted_key] = val
|
||||||
|
|
||||||
|
if cli.args.var:
|
||||||
|
# dump out requested arg
|
||||||
|
print(data[cli.args.var])
|
||||||
|
else:
|
||||||
|
# dump out everything
|
||||||
|
for key, val in data.items():
|
||||||
|
print(f'{key}="{val}"')
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
[bumpversion]
|
[bumpversion]
|
||||||
current_version = 0.0.43
|
current_version = 0.0.46
|
||||||
commit = True
|
commit = True
|
||||||
tag = True
|
tag = True
|
||||||
tag_name = {new_version}
|
tag_name = {new_version}
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ if __name__ == "__main__":
|
|||||||
long_description=long_description,
|
long_description=long_description,
|
||||||
long_description_content_type="text/markdown",
|
long_description_content_type="text/markdown",
|
||||||
packages=find_packages(),
|
packages=find_packages(),
|
||||||
py_modules=['milc'],
|
py_modules=['qmk_cli'],
|
||||||
classifiers=[
|
classifiers=[
|
||||||
'Development Status :: 3 - Alpha',
|
'Development Status :: 3 - Alpha',
|
||||||
'Environment :: Console',
|
'Environment :: Console',
|
||||||
@@ -45,11 +45,13 @@ if __name__ == "__main__":
|
|||||||
"colorama",
|
"colorama",
|
||||||
"dotty-dict",
|
"dotty-dict",
|
||||||
"flake8",
|
"flake8",
|
||||||
|
"hid",
|
||||||
"hjson",
|
"hjson",
|
||||||
"jsonschema>=3",
|
"jsonschema>=3",
|
||||||
"milc>=1.0.8",
|
"milc>=1.3.0",
|
||||||
"nose2",
|
"nose2",
|
||||||
"pygments",
|
"pygments",
|
||||||
|
"pyusb",
|
||||||
"yapf"
|
"yapf"
|
||||||
],
|
]
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user