New release: 0.0.47 → 0.0.48

fixes #50

.github/workflows/python-publish.yml

@@ -0,0 +1,47 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  workflow_dispatch:
+    inputs:
+      version_part:
+        description: 'Which part of the version to increment (patch, minor, major)'
+        required: true
+        default: 'patch'
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.7'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel 
+        pip install -r requirements-dev.txt
+    - name: Bump version
+      run: |
+        git config --local user.email "hello@qmk.fm"
+        git config --local user.name "QMK Bot"
+        bumpversion ${{ github.event.inputs.version_part }}
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        branch: master
+        tags: true
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

README.md

@@ -1,5 +1,6 @@
 # QMK CLI
 [![CLI Setup](https://github.com/qmk/qmk_cli/workflows/CLI%20Setup/badge.svg)](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/).
 
 # Features
@@ -8,15 +9,16 @@ A program to help users work with [QMK Firmware](https://qmk.fm/).
 * Use `qmk clone` to pull down anyone's `qmk_firmware` fork
 * Setup your build environment with `qmk setup`
 * Check that your environment is correctly setup with `qmk doctor`
-* Dispatches to `qmk_firmware/bin/qmk` for additional functionality:
+* Integrates with qmk_firmware for additional functionality:
-    * `qmk compile-json`
+    * `qmk compile`
-    * More to come
+    * `qmk console`
+    * `qmk flash`
+    * `qmk lint`
+    * ...and many more!
 
 # Quickstart
 
-Full documentation: <https://docs.qmk.fm/#/tutorial>
-
-Basic steps:
-
 * `python3 -m pip install qmk`
 * `qmk setup`
+
+Full documentation: <https://docs.qmk.fm/#/tutorial>

qmk_cli/__init__.py

@@ -1,3 +1,3 @@
 """A program to help you work with qmk_firmware."""
 
-__version__ = '0.0.41'
+__version__ = '0.0.48'

qmk_cli/helpers.py

@@ -8,58 +8,22 @@ from pathlib import Path
 from milc import cli
 
 
-def broken_module_imports():
+def is_qmk_firmware(qmk_firmware):
-    """Make sure we can import all the python modules.
+    """Returns True if the given Path() is a qmk_firmware clone.
     """
-    broken_modules = find_broken_requirements('requirements.txt')
+    paths = [
-    broken_dev_modules = find_broken_requirements('requirements-dev.txt') if cli.config.user.developer else []
+        qmk_firmware,
-    to_return = [False, False]
+        qmk_firmware / 'quantum',
+        qmk_firmware / 'requirements.txt',
+        qmk_firmware / 'requirements-dev.txt',
+        qmk_firmware / 'lib/python/qmk/cli/doctor.py'
+    ]
 
-    if broken_modules:
+    for path in paths:
-        to_return[0] = True
+        if not path.exists():
+            return False
 
-    if broken_dev_modules:
+    return True
-        to_return[1] = True
-
-    for module in broken_modules + broken_dev_modules:
-        print('Could not find module %s!' % module)
-
-    return to_return
-
-
-def find_broken_requirements(requirements):
-    """ Check if the modules in the given requirements.txt are available.
-
-    Args:
-
-        requirements
-            The path to a requirements.txt file
-
-    Returns a list of modules that couldn't be imported
-    """
-    with Path(requirements).open() as fd:
-        broken_modules = []
-
-        for line in fd.readlines():
-            line = line.strip().replace('<', '=').replace('>', '=')
-
-            if len(line) == 0 or line[0] == '#' or line.startswith('-r'):
-                continue
-
-            if '#' in line:
-                line = line.split('#')[0]
-
-            module_name = line.split('=')[0] if '=' in line else line
-            module_import_name = module_name.replace('-', '_')
-
-            # Not every module is importable by its own name.
-            if module_name == "pep8-naming":
-                module_import_name = "pep8ext_naming"
-
-            if not find_spec(module_import_name):
-                broken_modules.append(module_name)
-
-        return broken_modules
 
 
 @lru_cache(maxsize=2)
@@ -88,9 +52,7 @@ def in_qmk_firmware():
     """
     cur_dir = Path.cwd()
     while len(cur_dir.parents) > 0:
-        found_lib = cur_dir / 'lib/python/qmk/cli/__init__.py'
+        if is_qmk_firmware(cur_dir):
-        found_quantum = cur_dir / 'quantum'
-        if found_lib.is_file() and found_quantum.is_dir():
             return cur_dir
 
         # Move up a directory before the next iteration

qmk_cli/script_qmk.py

@@ -14,7 +14,7 @@ import milc
 import milc.subcommand.config  # noqa
 from milc.questions import yesno
 
-from .helpers import broken_module_imports, find_qmk_firmware
+from .helpers import find_qmk_firmware, is_qmk_firmware
 
 milc.EMOJI_LOGLEVELS['INFO'] = '{fg_blue}Ψ{style_reset_all}'
 
@@ -65,34 +65,9 @@ def main():
     import qmk_cli.subcommands
 
     # Check out and initialize the qmk_firmware environment
-    if qmk_firmware.exists():
+    if is_qmk_firmware(qmk_firmware):
         # All subcommands are run relative to the qmk_firmware root to make it easier to use the right copy of qmk_firmware.
         os.chdir(str(qmk_firmware))
-
-        # Check to make sure we have all the requirements
-        broken_modules, broken_dev_modules = broken_module_imports()
-        msg_install = 'Please run `python3 -m pip install -r %s` to install required python dependencies.'
-
-        if broken_modules:
-            if yesno('Would you like to install the required Python modules?'):
-                run_cmd(sys.executable, '-m', 'pip', 'install', '-r', 'requirements.txt')
-            else:
-                print()
-                print(msg_install % (os.environ['QMK_HOME'] + '/requirements.txt',))
-                print()
-                exit(1)
-
-        if broken_dev_modules:
-            if yesno('Would you like to install the required developer Python modules?'):
-                run_cmd(sys.executable, '-m', 'pip', 'install', '-r', 'requirements.txt')
-            else:
-                print()
-                print(msg_install % (os.environ['QMK_HOME'] + '/requirements-dev.txt',))
-                print('You can also turn off developer mode: qmk config user.developer=None')
-                print()
-                exit(1)
-
-        # Environment looks good, include the qmk_firmware subcommands
         sys.path.append(str(qmk_firmware / 'lib/python'))
 
         try:

qmk_cli/subcommands/__init__.py

@@ -3,4 +3,5 @@
 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 env  # noqa
 from . import setup  # noqa

qmk_cli/subcommands/env.py

@@ -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}"')

qmk_cli/subcommands/setup.py

@@ -9,6 +9,7 @@ from pathlib import Path
 from milc import cli
 from milc.questions import yesno
 from qmk_cli.git import git_clone
+from qmk_cli.helpers import is_qmk_firmware
 
 default_base = 'https://github.com'
 default_repo = 'qmk_firmware'
@@ -42,24 +43,6 @@ def git_upstream(destination):
         return False
 
 
-def is_qmk_firmware(qmk_firmware):
-    """Returns True if the given Path() is a qmk_firmware clone.
-    """
-    paths = [
-        qmk_firmware,
-        qmk_firmware / 'Makefile',
-        qmk_firmware / 'requirements.txt',
-        qmk_firmware / 'requirements-dev.txt',
-        qmk_firmware / 'lib/python/qmk/cli/doctor.py'
-    ]
-
-    for path in paths:
-        if not path.exists():
-            return False
-
-    return True
-
-
 @cli.argument('-n', '--no', arg_only=True, action='store_true', help='Answer no to all questions')
 @cli.argument('-y', '--yes', arg_only=True, action='store_true', help='Answer yes to all questions')
 @cli.argument('--baseurl', default=default_base, help='The URL all git operations start from. Default: %s' % default_base)
@@ -107,7 +90,9 @@ def setup(cli):
         cli.write_config_option('user', 'qmk_home')
 
     # Run `qmk doctor` to check the rest of the environment out
-    doctor_command = [sys.executable, sys.argv[0], 'doctor']
+    color = '--color' if cli.config.general.color else '--no-color'
+    unicode = '--unicode' if cli.config.general.unicode else '--no-unicode'
+    doctor_command = [sys.argv[0], color, unicode, 'doctor']
 
     if cli.args.no:
         doctor_command.append('--no')

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.41
+current_version = 0.0.48
 commit = True
 tag = True
 tag_name = {new_version}

setup.py

@@ -24,7 +24,7 @@ if __name__ == "__main__":
         long_description=long_description,
         long_description_content_type="text/markdown",
         packages=find_packages(),
-        py_modules=['milc'],
+        py_modules=['qmk_cli'],
         classifiers=[
             'Development Status :: 3 - Alpha',
             'Environment :: Console',
@@ -45,11 +45,13 @@ if __name__ == "__main__":
             "colorama",
             "dotty-dict",
             "flake8",
+            "hid",
             "hjson",
             "jsonschema>=3",
-            "milc>=1.0.8",
+            "milc>=1.3.0",
             "nose2",
             "pygments",
+            "pyusb",
             "yapf"
-        ],
+        ]
     )