New release: 1.0.0 → 1.1.0

Fix typo

.bumpversion.cfg

@@ -0,0 +1,12 @@
+[bumpversion]
+current_version = 1.1.0
+commit = True
+tag = True
+tag_name = {new_version}
+message = New release: {current_version} → {new_version}
+
+[bumpversion:file:.bumpversion.cfg]
+
+[bumpversion:file:qmk_cli/__init__.py]
+
+[bumpversion:file:setup.cfg]

.github/dependabot.yml

@@ -7,6 +7,8 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+    reviewers:
+      - "qmk/collaborators"
   - package-ecosystem: "pip" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:

.github/workflows/cli_setup.yml

@@ -17,10 +17,10 @@ jobs:
         python-version: [3.7, 3.8, 3.9]
 
     steps:
-    - uses: actions/checkout@v2.3.4
+    - uses: actions/checkout@v3
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2.2.2
+      uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -33,25 +33,24 @@ jobs:
       QMK_HOME: $HOME/qmk_firmware
 
     steps:
-    - uses: actions/checkout@v2.3.4
+    - uses: actions/checkout@v3
 
     - name: (MSYS2) Setup and install dependencies
       uses: msys2/setup-msys2@v2
       with:
         update: true
-        install: git mingw-w64-x86_64-toolchain mingw-w64-x86_64-python-pip
+        install: git mingw-w64-x86_64-toolchain mingw-w64-x86_64-python-pip mingw-w64-x86_64-python-pillow
 
     - name: (MSYS2) Install Python dependencies
       shell: msys2 {0}
       run: |
-        python3 -m pip install wheel
+        python3 -m pip install -U setuptools wheel
     - name: (MSYS2) Install QMK CLI from source
       shell: msys2 {0}
       run: |
-        python3 -m pip install -r requirements.txt
-        python3 setup.py sdist bdist_wheel
-        cd ..
-        python3 -m pip install --force-reinstall --no-index --no-deps --find-links qmk_cli/dist qmk
+        python3 -m pip install -U build
+        python3 -m build
+        python3 -m pip install dist/qmk-*.tar.gz
     - name: (MSYS2) Run qmk setup -y
       shell: msys2 {0}
       run: qmk setup -y

.github/workflows/codeql-analysis.yml

@@ -39,11 +39,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2.3.4
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -54,7 +54,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -68,4 +68,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/docker-republish.yml

@@ -0,0 +1,35 @@
+name: Rebuild Docker Image
+
+on:
+  workflow_dispatch:
+
+jobs:
+  redeploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.7'
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - name: 'Get Previous tag'
+      id: previoustag
+      uses: "WyriHaximus/github-action-get-previous-tag@v1"
+    - name: Download previous artifact
+      run: |
+        pip download -d "${GITHUB_WORKSPACE}/dist" qmk=="${{ steps.previoustag.outputs.tag }}"
+    - name: Log in to Docker Hub
+      uses: docker/login-action@v2.0.0
+      with:
+        username: ${{ secrets.DOCKER_HUB_USERNAME }}
+        password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+    - name: Build and Push to Docker Hub
+      uses: docker/build-push-action@v3.0.0
+      with:
+        context: .
+        push: true
+        tags: qmkfm/qmk_cli:latest

.github/workflows/python-publish.yml

@@ -17,16 +17,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2.3.4
+    - uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v2.2.2
+      uses: actions/setup-python@v3
       with:
         python-version: '3.7'
     - name: Run ci_tests
       run: ./ci_tests
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
+        python3 -m pip install --upgrade pip
         pip install setuptools wheel 
         pip install -r requirements-dev.txt
     - name: Bump version
@@ -45,16 +45,20 @@ jobs:
         TWINE_USERNAME: qmk
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
       run: |
-        python setup.py sdist bdist_wheel
+        python3 -m build
         twine upload dist/*
     - name: Log in to Docker Hub
-      uses: docker/login-action@v1.10.0
+      uses: docker/login-action@v2.0.0
       with:
         username: ${{ secrets.DOCKER_HUB_USERNAME }}
         password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
     - name: Build and Push to Docker Hub
-      uses: docker/build-push-action@v2.6.1
+      uses: docker/build-push-action@v3.0.0
       with:
         context: .
         push: true
         tags: qmkfm/qmk_cli:latest
+    - name: Trigger OS package builds
+      run: ./trigger_packages
+      env:
+        QMK_BOT_TOKEN: ${{ secrets.QMK_BOT_TOKEN }}

README.md

@@ -17,9 +17,43 @@ A program to help users work with [QMK Firmware](https://qmk.fm/).
     * `qmk lint`
     * ...and many more!
 
+# Packages
+
+We provide "install and go" packages for many Operating Systems.
+
+## Linux
+
+Packages for several distributions available here: https://github.com/qmk/qmk_fpm
+
+## macOS
+
+Using [Homebrew](https://brew.sh):
+
+    brew install qmk/qmk/qmk
+
+## Windows
+
+Download our custom MSYS2 installer here: https://msys.qmk.fm/
+
 # Quickstart
 
 * `python3 -m pip install qmk`
 * `qmk setup`
 
+# Building
+
+We follow PEP517, you can install using [build](https://pypi.org/project/build/):
+
+Setup:
+
+    python3 -m pip install build
+
+Build:
+
+    python3 -m build
+
+You can read more about working with PEP517 packages in the [Python Packaging User Guide](https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-your-project).
+
+# Documentation
+
 Full documentation: <https://docs.qmk.fm/#/tutorial>

pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

qmk_cli/__init__.py

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

qmk_cli/subcommands/clone.py

@@ -11,20 +11,20 @@ default_fork = 'qmk/' + default_repo
 default_branch = 'master'
 
 
-@cli.argument('--baseurl', default='https://github.com', help='The URL all git operations start from (Default: https://github.com)')
-@cli.argument('-b', '--branch', default=default_branch, help='The branch to clone. Default: %s' % default_branch)
-@cli.argument('destination', default=None, nargs='?', help='The directory to clone to. Default: (current directory)')
-@cli.argument('fork', default=default_fork, nargs='?', help='The qmk_firmware fork to clone. Default: %s' % default_fork)
+@cli.argument('--baseurl', arg_only=True, default='https://github.com', help='The URL all git operations start from (Default: https://github.com)')
+@cli.argument('-b', '--branch', arg_only=True, default=default_branch, help='The branch to clone. Default: %s' % default_branch)
+@cli.argument('destination', arg_only=True, default=None, nargs='?', help='The directory to clone to. Default: (current directory)')
+@cli.argument('fork', arg_only=True, default=default_fork, nargs='?', help='The qmk_firmware fork to clone. Default: %s' % default_fork)
 @cli.subcommand('Clone a qmk_firmware fork.')
 def clone(cli):
     if not cli.args.destination:
         cli.args.destination = os.path.join(os.environ['ORIG_CWD'], default_fork.split('/')[-1])
 
     qmk_firmware = Path(cli.args.destination)
-    git_url = '/'.join((cli.config.clone.baseurl, cli.args.fork))
+    git_url = '/'.join((cli.args.baseurl, cli.args.fork))
 
     if qmk_firmware.exists():
         cli.log.error('Destination already exists: %s', cli.args.destination)
         exit(1)
 
-    return git_clone(git_url, cli.args.destination, cli.config.clone.branch)
+    return git_clone(git_url, cli.args.destination, cli.args.branch)

qmk_cli/subcommands/console.py

@@ -25,6 +25,8 @@ LOG_COLOR = {
 
 KNOWN_BOOTLOADERS = {
     # VID  ,  PID
+    ('03EB', '2045'): 'lufa-ms: LUFA Mass Storage Bootloader',
+    ('03EB', '2067'): 'qmk-hid: HID Bootloader',
     ('03EB', '2FEF'): 'atmel-dfu: ATmega16U2',
     ('03EB', '2FF0'): 'atmel-dfu: ATmega32U2',
     ('03EB', '2FF3'): 'atmel-dfu: ATmega16U4',
@@ -34,21 +36,20 @@ KNOWN_BOOTLOADERS = {
     ('03EB', '2FFB'): 'atmel-dfu: AT90USB128',
     ('03EB', '6124'): 'Microchip SAM-BA',
     ('0483', 'DF11'): 'stm32-dfu: STM32 BOOTLOADER',
-    ('16C0', '05DC'): 'USBasp: USBaspLoader',
-    ('16C0', '05DF'): 'bootloadHID: HIDBoot',
+    ('16C0', '05DC'): 'usbasploader: USBaspLoader',
+    ('16C0', '05DF'): 'bootloadhid: HIDBoot',
     ('16C0', '0478'): 'halfkay: Teensy Halfkay',
     ('1B4F', '9203'): 'caterina: Pro Micro 3.3V',
     ('1B4F', '9205'): 'caterina: Pro Micro 5V',
     ('1B4F', '9207'): 'caterina: LilyPadUSB',
     ('1C11', 'B007'): 'kiibohd: Kiibohd DFU Bootloader',
     ('1EAF', '0003'): 'stm32duino: Maple 003',
-    ('1FFB', '0101'): 'caterina: Polou A-Star 32U4 Bootloader',
+    ('1FFB', '0101'): 'caterina: Pololu A-Star 32U4 Bootloader',
     ('2341', '0036'): 'caterina: Arduino Leonardo',
     ('2341', '0037'): 'caterina: Arduino Micro',
     ('239A', '000C'): 'caterina: Adafruit Feather 32U4',
     ('239A', '000D'): 'caterina: Adafruit ItsyBitsy 32U4 3v',
     ('239A', '000E'): 'caterina: Adafruit ItsyBitsy 32U4 5v',
-    ('239A', '000E'): 'caterina: Adafruit ItsyBitsy 32U4 5v',
     ('2A03', '0036'): 'caterina: Arduino Leonardo',
     ('2A03', '0037'): 'caterina: Arduino Micro',
     ('314B', '0106'): 'apm32-dfu: APM32 DFU ISP Mode'

qmk_cli/subcommands/env.py

@@ -7,7 +7,7 @@ from milc import cli
 from qmk_cli.helpers import is_qmk_firmware
 
 
-@cli.argument('var', default=None, nargs='?', help='Optional variable to query')
+@cli.argument('var', arg_only=True, default=None, nargs='?', help='Optional variable to query')
 @cli.subcommand('Prints environment information.')
 def env(cli):
     home = os.environ.get('QMK_HOME', "")

qmk_cli/subcommands/setup.py

@@ -20,7 +20,7 @@ default_branch = 'master'
 def git_upstream(destination):
     """Add the qmk/qmk_firmware upstream to a qmk_firmware clone.
     """
-    git_url = '/'.join((cli.config.setup.baseurl, default_fork))
+    git_url = '/'.join((cli.args.baseurl, default_fork))
     git_cmd = [
         'git',
         '-C',
@@ -45,10 +45,10 @@ def git_upstream(destination):
 
 @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)
-@cli.argument('-b', '--branch', default=default_branch, help='The branch to clone. Default: %s' % default_branch)
-@cli.argument('-H', '--home', default=Path(os.environ['QMK_HOME']), type=Path, help='The location for QMK Firmware. Default: %s' % os.environ['QMK_HOME'])
-@cli.argument('fork', default=default_fork, nargs='?', help='The qmk_firmware fork to clone. Default: %s' % default_fork)
+@cli.argument('--baseurl', arg_only=True, default=default_base, help='The URL all git operations start from. Default: %s' % default_base)
+@cli.argument('-b', '--branch', arg_only=True, default=default_branch, help='The branch to clone. Default: %s' % default_branch)
+@cli.argument('-H', '--home', arg_only=True, default=Path(os.environ['QMK_HOME']), type=Path, help='The location for QMK Firmware. Default: %s' % os.environ['QMK_HOME'])
+@cli.argument('fork', arg_only=True, default=default_fork, nargs='?', help='The qmk_firmware fork to clone. Default: %s' % default_fork)
 @cli.subcommand('Setup your computer for qmk_firmware.')
 def setup(cli):
     """Guide the user through setting up their QMK environment.
@@ -77,9 +77,9 @@ def setup(cli):
     else:
         cli.log.error('Could not find qmk_firmware!')
         if yesno(clone_prompt):
-            git_url = '/'.join((cli.config.setup.baseurl, cli.args.fork))
+            git_url = '/'.join((cli.args.baseurl, cli.args.fork))
 
-            if git_clone(git_url, cli.args.home, cli.config.setup.branch):
+            if git_clone(git_url, cli.args.home, cli.args.branch):
                 git_upstream(cli.args.home)
             else:
                 exit(1)

requirements-dev.txt

@@ -1,29 +1,4 @@
-bleach==4.0.0
-bump2version==1.0.1
-bumpversion==0.6.0
-certifi==2021.5.30
-cffi==1.14.6
-chardet==4.0.0
-colorama==0.4.4
-cryptography==3.4.7
-docutils==0.17.1
-idna==2.10
-importlib-metadata==4.6.3
-jeepney==0.7.1
-keyring==23.0.1
-packaging==21.0
-pkginfo==1.7.1
-pycparser==2.20
-Pygments==2.9.0
-pyparsing==2.4.7
-readme-renderer==29.0
-requests==2.26.0
-requests-toolbelt==0.9.1
-rfc3986==1.5.0
-SecretStorage==3.3.1
-six==1.16.0
-tqdm==4.62.0
-twine==3.4.2
-urllib3==1.26.6
-webencodings==0.5.1
-zipp==3.5.0
+build
+bumpversion
+requests
+twine

setup.cfg

@@ -1,13 +1,5 @@
-[bumpversion]
-current_version = 0.3.0
-commit = True
-tag = True
-tag_name = {new_version}
-message = New release: {current_version} → {new_version}
-
-[bumpversion:file:qmk_cli/__init__.py]
-
-[bumpversion:file:setup.cfg]
+#[bumpversion]
+# Bumpversion config has been moved to .bumpversion.cfg
 
 [bdist_wheel]
 universal = 1
@@ -16,17 +8,50 @@ universal = 1
 ignore = E501,E226
 
 [metadata]
+name = qmk
+version = 1.1.0
 author = skullydazed
-author-email = skullydazed@gmail.com
-description-file = README.md
-dist-name = qmk
-license_file = LICENSE
-module = qmk_cli
-home-page = https://github.com/qmk/qmk_cli
-requires-python = >=3.7
+author_email = skullydazed@gmail.com
+description = A program to help users work with QMK Firmware.
+long_description = file: README.md
+long_description_content_type = text/markdown
+license = MIT License
+project_urls = 
+	Bug Tracker = https://github.com/qmk/qmk_cli/issues
+	Documentation = https://docs.qmk.fm/#/cli
+	Homepage = https://qmk.fm/
+	Source = https://github.com/qmk/qmk_cli/
+classifiers = 
+	Development Status :: 3 - Alpha
+	Environment :: Console
+	Intended Audience :: Developers
+	Intended Audience :: System Administrators
+	Intended Audience :: End Users/Desktop
+	License :: OSI Approved :: MIT License
+	Natural Language :: English
+	Programming Language :: Python :: 3 :: Only
+	Topic :: Scientific/Engineering
+	Topic :: Software Development
+	Topic :: Utilities
 
-[entry_points]
-qmk = qmk_cli.script_qmk:main
+[options]
+install_requires = 
+	hid
+	milc>=1.4.2
+	pyusb
+	setuptools>=45
+	# qmk_firmware packages
+	hjson
+	jsonschema>=4
+	pygments
+	qmk-dotty-dict
+	pillow
+packages = find:
+python_requires = >=3.7
+
+[options.entry_points]
+console_scripts = 
+	qmk = qmk_cli.script_qmk:main
 
 [yapf]
 align_closing_bracket_with_visual_indent = True

setup.py

@@ -1,69 +0,0 @@
-from configparser import ConfigParser
-from setuptools import setup, find_packages
-
-setup_cfg = ConfigParser()
-setup_cfg.read('setup.cfg')
-metadata = setup_cfg['metadata']
-
-if __name__ == "__main__":
-    with open('README.md', encoding='utf-8') as readme_file:
-        long_description = readme_file.read()
-    setup(
-        name=metadata['dist-name'],
-        description='A program to help users work with QMK Firmware.',
-        entry_points={
-            'console_scripts': ['%s = %s' % i for i in setup_cfg['entry_points'].items()],
-        },
-        license='MIT License',
-        url=metadata['home-page'],
-        version=setup_cfg['bumpversion']['current_version'],
-        author=metadata['author'],
-        author_email=metadata['author-email'],
-        maintainer=metadata['author'],
-        maintainer_email=metadata['author-email'],
-        long_description=long_description,
-        long_description_content_type="text/markdown",
-        packages=find_packages(),
-        py_modules=['qmk_cli'],
-        classifiers=[
-            'Development Status :: 3 - Alpha',
-            'Environment :: Console',
-            'Intended Audience :: Developers',
-            'Intended Audience :: System Administrators',
-            'Intended Audience :: End Users/Desktop',
-            'License :: OSI Approved :: MIT License',
-            'Natural Language :: English',
-            'Programming Language :: Python :: 3 :: Only',
-            'Topic :: Scientific/Engineering',
-            'Topic :: Software Development',
-            'Topic :: Utilities',
-        ],
-        python_requires=metadata['requires-python'],
-        install_requires=[
-            "appdirs==1.4.4",
-            "argcomplete==1.12.3",
-            "attrs==21.2.0",
-            "colorama==0.4.4",
-            "coverage==5.5",
-            "qmk-dotty-dict==1.3.0.post1",
-            "flake8==3.9.2",
-            "halo==0.0.31",
-            "hid==1.0.4",
-            "hjson==3.0.2",
-            "jsonschema==3.2.0",
-            "log-symbols==0.0.14",
-            "mccabe==0.6.1",
-            "milc==1.5.0",
-            "nose2==0.10.0",
-            "pycodestyle==2.7.0",
-            "pyflakes==2.3.1",
-            "Pygments==2.9.0",
-            "pyrsistent==0.18.0",
-            "pyusb==1.2.1",
-            "setuptools>=45",
-            "six==1.16.0",
-            "spinners==0.0.24",
-            "termcolor==1.1.0",
-            "yapf==0.31.0"
-        ]
-    )

trigger_packages

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+"""Trigger workflows that build QMK packages.
+"""
+from os import environ
+from pathlib import Path
+
+import requests
+
+# Pull in environment vars
+gh_user = environ.get('GH_USERNAME', 'qmk-bot')
+gh_pat = environ.get('QMK_BOT_TOKEN', '')
+gh_repo_owner = environ.get('REPO_OWNER', 'qmk')
+gh_repo_name = environ.get('REPO_NAME', 'qmk_fpm')
+gh_ref = environ.get('BRANCH_NAME', 'main')
+gh_workflow_ids = environ.get('WORKFLOW_IDS', 'debian-buster-publish.yml,fedora-32-publish.yml,ubuntu-focal-publish.yml').split(',')
+gh_api_url = environ.get('GITHUB_API_URL', 'https://api.github.com')
+gh_workflow_args = {'ref': gh_ref}
+gh_workflow_headers = {'Accept': 'application/vnd.github.v3+json'}
+
+for gh_workflow_id in gh_workflow_ids:
+    gh_workflow_endpoint = f'{gh_api_url}/repos/{gh_repo_owner}/{gh_repo_name}/actions/workflows/{gh_workflow_id}/dispatches'
+    print(f'Triggering {gh_workflow_id} workflow at: {gh_workflow_endpoint}')
+    workflow_dispatch = requests.post(gh_workflow_endpoint, headers=gh_workflow_headers, json=gh_workflow_args, auth=(gh_user, gh_pat))
+    if workflow_dispatch.status_code != 204:
+        print(f'Error from GitHub API, status_code {workflow_dispatch.status_code}!')
+        print(workflow_dispatch.text)
+        exit(1)
+
+exit(0)