Compare commits
47 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 5a777c5de9 | |||
| c51c898562 | |||
| 08ea23b087 | |||
| 0105405d83 | |||
| 92c57e2a46 | |||
| 30c89ec8e0 | |||
| a7a7bd9f08 | |||
| 5229ce14e3 | |||
| 8fa960f25e | |||
| 1481dfe157 | |||
| ac39b9bb0f | |||
| 44a446308f | |||
| 90bdf52416 | |||
| 191980052e | |||
| 5fbdd95c4b | |||
| 1002360e20 | |||
| a03aa1cbba | |||
| a0b692d718 | |||
| ab7d0c6e46 | |||
| 73c903b8b6 | |||
| 8f2185af32 | |||
| bae2f1f1ee | |||
| 120ce557f1 | |||
| a15b0d6460 | |||
| f0dafaf068 | |||
| 3414bdcaa3 | |||
| c8567d8098 | |||
| dc3ca88deb | |||
| a4e9c34387 | |||
| 742e1ce0e1 | |||
| 39df759f57 | |||
| b694c4284d | |||
| e184710036 | |||
| d67addde2d | |||
| 29541559d0 | |||
| db0b8cb9a0 | |||
| 6a0e62a078 | |||
| bbc5ffd6c9 | |||
| e0adba4e68 | |||
| 56bcb12ed6 | |||
| 897fe121e2 | |||
| 1a723e488f | |||
| bf502d26fa | |||
| ebea7f7ea0 | |||
| 49b288786a | |||
| e75b4d4ed1 | |||
| 7f56cfd781 |
@@ -0,0 +1,68 @@
|
||||
name: CLI Setup
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
test_cli_linux_macos:
|
||||
runs-on: ${{ matrix.os }}
|
||||
env:
|
||||
QMK_HOME: ~/qmk_firmware
|
||||
strategy:
|
||||
matrix:
|
||||
os: [macos-latest, ubuntu-latest]
|
||||
python-version: [3.6, 3.7, 3.8]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v1
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
- name: Install python dependencies
|
||||
run: |
|
||||
python -m pip install wheel
|
||||
echo "::add-path::$HOME/.local/bin"
|
||||
|
||||
- name: Install QMK CLI from source
|
||||
run: |
|
||||
python3 -m pip install -r requirements.txt
|
||||
python setup.py sdist bdist_wheel
|
||||
cd ..
|
||||
python3 -m pip install --force-reinstall --no-index --no-deps --prefix=~/.local --find-links qmk_cli/dist qmk
|
||||
|
||||
- name: Run qmk setup -y
|
||||
run: qmk setup -y
|
||||
|
||||
test_cli_win:
|
||||
runs-on: windows-latest
|
||||
strategy:
|
||||
matrix:
|
||||
python-version: [3.6, 3.8]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
|
||||
- name: Set up MSYS2
|
||||
uses: qmk/setup-msys2@v1
|
||||
with:
|
||||
update: true
|
||||
|
||||
- name: (MSYS2) Install git and python3
|
||||
run: msys2do pacman -S git python3-pip --noconfirm
|
||||
|
||||
- name: (MSYS2) Upgrade pip and setuptools and install wheel
|
||||
run: |
|
||||
msys2do python3 -m pip install --upgrade pip setuptools
|
||||
msys2do python3 -m pip install wheel
|
||||
|
||||
- name: (MSYS2) Install QMK CLI from source
|
||||
run: msys2do ./setup_msys.sh $(cygpath "${{ github.workspace }}")
|
||||
|
||||
- name: (MSYS2) Run qmk setup -y
|
||||
run: msys2do qmk setup -y
|
||||
@@ -1,5 +1,5 @@
|
||||
# QMK CLI
|
||||
|
||||
[](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
|
||||
|
||||
@@ -178,8 +178,9 @@ class ConfigurationSection(Configuration):
|
||||
|
||||
def __getitem__(self, key):
|
||||
"""Returns a config value, pulling from the `user` section as a fallback.
|
||||
This is called when the attribute is accessed either via the get method or through [ ] index.
|
||||
"""
|
||||
if key in self._config:
|
||||
if key in self._config and self._config.get(key) is not None:
|
||||
return self._config[key]
|
||||
|
||||
elif key in self.parent.user:
|
||||
@@ -187,6 +188,15 @@ class ConfigurationSection(Configuration):
|
||||
|
||||
return None
|
||||
|
||||
def __getattr__(self, key):
|
||||
"""Returns the config value from the `user` section.
|
||||
This is called when the attribute is accessed via dot notation but does not exists.
|
||||
"""
|
||||
if key in self.parent.user:
|
||||
return self.parent.user[key]
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def handle_store_boolean(self, *args, **kwargs):
|
||||
"""Does the add_argument for action='store_boolean'.
|
||||
@@ -232,15 +242,24 @@ class SubparserWrapper(object):
|
||||
|
||||
This also stores the default for the argument in `self.cli.default_arguments`.
|
||||
"""
|
||||
if 'action' in kwargs and kwargs['action'] == 'store_boolean':
|
||||
if kwargs.get('action') == 'store_boolean':
|
||||
# Store boolean will call us again with the enable/disable flag arguments
|
||||
return handle_store_boolean(self, *args, **kwargs)
|
||||
|
||||
self.cli.acquire_lock()
|
||||
argument_name = self.cli.get_argument_name(*args, **kwargs)
|
||||
|
||||
self.subparser.add_argument(*args, **kwargs)
|
||||
|
||||
if kwargs.get('action') == 'store_false':
|
||||
self.cli._config_store_false.append(argument_name)
|
||||
|
||||
if kwargs.get('action') == 'store_true':
|
||||
self.cli._config_store_true.append(argument_name)
|
||||
|
||||
if self.submodule not in self.cli.default_arguments:
|
||||
self.cli.default_arguments[self.submodule] = {}
|
||||
self.cli.default_arguments[self.submodule][self.cli.get_argument_name(*args, **kwargs)] = kwargs.get('default')
|
||||
self.cli.default_arguments[self.submodule][argument_name] = kwargs.get('default')
|
||||
self.cli.release_lock()
|
||||
|
||||
|
||||
@@ -258,12 +277,14 @@ class MILC(object):
|
||||
|
||||
# Define some basic info
|
||||
self.acquire_lock()
|
||||
self._config_store_true = []
|
||||
self._config_store_false = []
|
||||
self._description = None
|
||||
self._entrypoint = None
|
||||
self._inside_context_manager = False
|
||||
self.ansi = ansi_colors
|
||||
self.arg_only = []
|
||||
self.config = None
|
||||
self.arg_only = {}
|
||||
self.config = self.config_source = None
|
||||
self.config_file = None
|
||||
self.default_arguments = {}
|
||||
self.version = 'unknown'
|
||||
@@ -274,7 +295,7 @@ class MILC(object):
|
||||
self.prog_name = self.prog_name.split('/')[-1]
|
||||
|
||||
# Initialize all the things
|
||||
self.read_config_file()
|
||||
self.initialize_config()
|
||||
self.initialize_argparse()
|
||||
self.initialize_logging()
|
||||
|
||||
@@ -367,7 +388,7 @@ class MILC(object):
|
||||
self.add_argument('--log-file', help='File to write log messages to')
|
||||
self.add_argument('--color', action='store_boolean', default=True, help='color in output')
|
||||
self.add_argument('--config-file', help='The location for the configuration file')
|
||||
self.arg_only.append('config_file')
|
||||
self.arg_only['config_file'] = ['general']
|
||||
|
||||
def add_subparsers(self, title='Sub-commands', **kwargs):
|
||||
if self._inside_context_manager:
|
||||
@@ -417,17 +438,20 @@ class MILC(object):
|
||||
raise RuntimeError('You must run this before the with statement!')
|
||||
|
||||
def argument_function(handler):
|
||||
if 'arg_only' in kwargs and kwargs['arg_only']:
|
||||
subcommand_name = handler.__name__.replace("_", "-")
|
||||
|
||||
if kwargs.get('arg_only'):
|
||||
arg_name = self.get_argument_name(*args, **kwargs)
|
||||
self.arg_only.append(arg_name)
|
||||
if arg_name not in self.arg_only:
|
||||
self.arg_only[arg_name] = []
|
||||
self.arg_only[arg_name].append(subcommand_name)
|
||||
del kwargs['arg_only']
|
||||
|
||||
name = handler.__name__.replace("_", "-")
|
||||
if handler is self._entrypoint:
|
||||
self.add_argument(*args, **kwargs)
|
||||
|
||||
elif name in self.subcommands:
|
||||
self.subcommands[name].add_argument(*args, **kwargs)
|
||||
elif subcommand_name in self.subcommands:
|
||||
self.subcommands[subcommand_name].add_argument(*args, **kwargs)
|
||||
|
||||
else:
|
||||
raise RuntimeError('Decorated function is not entrypoint or subcommand!')
|
||||
@@ -458,21 +482,20 @@ class MILC(object):
|
||||
|
||||
self.release_lock()
|
||||
|
||||
def read_config_file(self):
|
||||
"""Read in the configuration file and store it in self.config.
|
||||
def read_config_file(self, config_file):
|
||||
"""Read in the configuration file and return Configuration objects for it and the config_source.
|
||||
"""
|
||||
self.acquire_lock()
|
||||
self.config = Configuration()
|
||||
self.config_file = self.find_config_file()
|
||||
config = Configuration()
|
||||
config_source = Configuration()
|
||||
|
||||
if self.config_file and self.config_file.exists():
|
||||
config = RawConfigParser(self.config)
|
||||
config.read(str(self.config_file))
|
||||
if config_file.exists():
|
||||
raw_config = RawConfigParser()
|
||||
raw_config.read(str(config_file))
|
||||
|
||||
# Iterate over the config file options and write them into self.config
|
||||
for section in config.sections():
|
||||
for option in config.options(section):
|
||||
value = config.get(section, option)
|
||||
# Iterate over the config file options and write them into config
|
||||
for section in raw_config.sections():
|
||||
for option in raw_config.options(section):
|
||||
value = raw_config.get(section, option)
|
||||
|
||||
# Coerce values into useful datatypes
|
||||
if value.lower() in ['1', 'yes', 'true', 'on']:
|
||||
@@ -487,8 +510,17 @@ class MILC(object):
|
||||
else:
|
||||
value = int(value)
|
||||
|
||||
self.config[section][option] = value
|
||||
config[section][option] = value
|
||||
config_source[section][option] = 'config_file'
|
||||
|
||||
return config, config_source
|
||||
|
||||
def initialize_config(self):
|
||||
"""Read in the configuration file and store it in self.config.
|
||||
"""
|
||||
self.acquire_lock()
|
||||
self.config_file = self.find_config_file()
|
||||
self.config, self.config_source = self.read_config_file(self.config_file)
|
||||
self.release_lock()
|
||||
|
||||
def merge_args_into_config(self):
|
||||
@@ -499,30 +531,88 @@ class MILC(object):
|
||||
if argument in ('subparsers', 'entrypoint'):
|
||||
continue
|
||||
|
||||
if argument not in self.arg_only:
|
||||
# Find the argument's section
|
||||
if self._entrypoint.__name__ in self.default_arguments and argument in self.default_arguments[self._entrypoint.__name__]:
|
||||
argument_found = True
|
||||
section = self._entrypoint.__name__
|
||||
if argument in self.default_arguments['general']:
|
||||
argument_found = True
|
||||
section = 'general'
|
||||
# Find the argument's section
|
||||
# Underscores in command's names are converted to dashes during initialization.
|
||||
# TODO(Erovia) Find a better solution
|
||||
entrypoint_name = self._entrypoint.__name__.replace("_", "-")
|
||||
if entrypoint_name in self.default_arguments and argument in self.default_arguments[entrypoint_name]:
|
||||
argument_found = True
|
||||
section = self._entrypoint.__name__
|
||||
if argument in self.default_arguments['general']:
|
||||
argument_found = True
|
||||
section = 'general'
|
||||
|
||||
if not argument_found:
|
||||
raise RuntimeError('Could not find argument in `self.default_arguments`. This should be impossible!')
|
||||
exit(1)
|
||||
if not argument_found:
|
||||
raise RuntimeError('Could not find argument in `self.default_arguments`. This should be impossible!')
|
||||
exit(1)
|
||||
|
||||
if argument not in self.arg_only or section not in self.arg_only[argument]:
|
||||
# Determine the arg value and source
|
||||
arg_value = getattr(self.args, argument)
|
||||
if argument in self._config_store_true and arg_value:
|
||||
passed_on_cmdline = True
|
||||
elif argument in self._config_store_false and not arg_value:
|
||||
passed_on_cmdline = True
|
||||
elif arg_value is not None:
|
||||
passed_on_cmdline = True
|
||||
else:
|
||||
passed_on_cmdline = False
|
||||
|
||||
# Merge this argument into self.config
|
||||
if argument in self.default_arguments:
|
||||
arg_value = getattr(self.args, argument)
|
||||
if arg_value:
|
||||
self.config[section][argument] = arg_value
|
||||
else:
|
||||
if argument not in self.config[section]:
|
||||
self.config[section][argument] = getattr(self.args, argument)
|
||||
if passed_on_cmdline and (argument in self.default_arguments['general'] or argument in self.default_arguments[entrypoint_name] or argument not in self.config[entrypoint_name]):
|
||||
self.config[section][argument] = arg_value
|
||||
self.config_source[section][argument] = 'argument'
|
||||
|
||||
self.release_lock()
|
||||
|
||||
def _save_config_file(self, config):
|
||||
"""Write config to disk.
|
||||
"""
|
||||
# Generate a sanitized version of our running configuration
|
||||
sane_config = RawConfigParser()
|
||||
for section_name, section in config._config.items():
|
||||
sane_config.add_section(section_name)
|
||||
for option_name, value in section.items():
|
||||
if section_name == 'general':
|
||||
if option_name in ['config_file']:
|
||||
continue
|
||||
if value is not None:
|
||||
sane_config.set(section_name, option_name, str(value))
|
||||
|
||||
config_dir = self.config_file.parent
|
||||
if not config_dir.exists():
|
||||
config_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Write the config file atomically.
|
||||
self.acquire_lock()
|
||||
with NamedTemporaryFile(mode='w', dir=str(config_dir), delete=False) as tmpfile:
|
||||
sane_config.write(tmpfile)
|
||||
|
||||
if os.path.getsize(tmpfile.name) > 0:
|
||||
os.replace(tmpfile.name, str(self.config_file))
|
||||
else:
|
||||
self.log.warning('Config file saving failed, not replacing %s with %s.', str(self.config_file), tmpfile.name)
|
||||
self.release_lock()
|
||||
|
||||
def write_config_option(self, section, option):
|
||||
"""Save a single config option to the config file.
|
||||
"""
|
||||
if not self.config_file:
|
||||
self.log.warning('%s.config_file not set, not saving config!', self.__class__.__name__)
|
||||
return
|
||||
|
||||
config, config_source = self.read_config_file(self.config_file)
|
||||
|
||||
if section in config and option in config[section] and config[section][option] is None:
|
||||
del(config[section][option])
|
||||
else:
|
||||
config[section][option] = str(self.config[section][option])
|
||||
|
||||
self._save_config_file(config)
|
||||
|
||||
# Housekeeping
|
||||
self.log.info('Wrote configuration to %s', shlex.quote(str(self.config_file)))
|
||||
|
||||
def save_config(self):
|
||||
"""Save the current configuration to the config file.
|
||||
"""
|
||||
@@ -532,36 +622,9 @@ class MILC(object):
|
||||
self.log.warning('%s.config_file file not set, not saving config!', self.__class__.__name__)
|
||||
return
|
||||
|
||||
self.acquire_lock()
|
||||
|
||||
# Generate a sanitized version of our running configuration
|
||||
config = RawConfigParser()
|
||||
for section_name, section in self.config._config.items():
|
||||
config.add_section(section_name)
|
||||
for option_name, value in section.items():
|
||||
if section_name == 'general':
|
||||
if option_name in ['config_file']:
|
||||
continue
|
||||
if value is not None:
|
||||
config.set(section_name, option_name, str(value))
|
||||
|
||||
# Write out the config file
|
||||
config_dir = self.config_file.parent
|
||||
if not config_dir.exists():
|
||||
config_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
with NamedTemporaryFile(mode='w', dir=str(config_dir), delete=False) as tmpfile:
|
||||
config.write(tmpfile)
|
||||
|
||||
# Move the new config file into place atomically
|
||||
if os.path.getsize(tmpfile.name) > 0:
|
||||
os.rename(tmpfile.name, str(self.config_file))
|
||||
else:
|
||||
self.log.warning('Config file saving failed, not replacing %s with %s.', str(self.config_file), tmpfile.name)
|
||||
|
||||
# Housekeeping
|
||||
self.release_lock()
|
||||
cli.log.info('Wrote configuration to %s', shlex.quote(str(self.config_file)))
|
||||
# Write config to disk
|
||||
self._save_config_file(self.config)
|
||||
self.log.info('Wrote configuration to %s', shlex.quote(str(self.config_file)))
|
||||
|
||||
def __call__(self):
|
||||
"""Execute the entrypoint function.
|
||||
@@ -595,23 +658,25 @@ class MILC(object):
|
||||
|
||||
return entrypoint_func
|
||||
|
||||
def add_subcommand(self, handler, description, name=None, **kwargs):
|
||||
def add_subcommand(self, handler, description, name=None, hidden=False, **kwargs):
|
||||
"""Register a subcommand.
|
||||
|
||||
If name is not provided we use `handler.__name__`.
|
||||
"""
|
||||
|
||||
if self._inside_context_manager:
|
||||
raise RuntimeError('You must run this before the with statement!')
|
||||
|
||||
if self._subparsers is None:
|
||||
self.add_subparsers()
|
||||
self.add_subparsers(metavar="")
|
||||
|
||||
if not name:
|
||||
name = handler.__name__.replace("_", "-")
|
||||
|
||||
self.acquire_lock()
|
||||
|
||||
kwargs['help'] = description
|
||||
if not hidden:
|
||||
self._subparsers.metavar = "{%s,%s}" % (self._subparsers.metavar[1:-1], name) if self._subparsers.metavar else "{%s%s}" % (self._subparsers.metavar[1:-1], name)
|
||||
kwargs['help'] = description
|
||||
self.subcommands[name] = SubparserWrapper(self, name, self._subparsers.add_parser(name, **kwargs))
|
||||
self.subcommands[name].set_defaults(entrypoint=handler)
|
||||
|
||||
@@ -619,11 +684,11 @@ class MILC(object):
|
||||
|
||||
return handler
|
||||
|
||||
def subcommand(self, description, **kwargs):
|
||||
def subcommand(self, description, hidden=False, **kwargs):
|
||||
"""Decorator to register a subcommand.
|
||||
"""
|
||||
def subcommand_function(handler):
|
||||
return self.add_subcommand(handler, description, **kwargs)
|
||||
return self.add_subcommand(handler, description, hidden=hidden, **kwargs)
|
||||
|
||||
return subcommand_function
|
||||
|
||||
|
||||
+1
-1
@@ -1,3 +1,3 @@
|
||||
"""A program to help you work with qmk_firmware."""
|
||||
|
||||
__version__ = '0.0.24'
|
||||
__version__ = '0.0.35'
|
||||
|
||||
+5
-5
@@ -9,7 +9,7 @@ default_fork = 'qmk/' + default_repo
|
||||
default_branch = 'master'
|
||||
|
||||
|
||||
def clone(url, destination, branch):
|
||||
def git_clone(url, destination, branch):
|
||||
git_clone = [
|
||||
'git',
|
||||
'clone',
|
||||
@@ -20,13 +20,13 @@ def clone(url, destination, branch):
|
||||
]
|
||||
cli.log.debug('Git clone command: %s', git_clone)
|
||||
|
||||
with subprocess.Popen(git_clone, stderr=subprocess.STDOUT, stdout=subprocess.PIPE, bufsize=1, universal_newlines=True) as p:
|
||||
with subprocess.Popen(git_clone, stderr=subprocess.STDOUT, stdout=subprocess.PIPE, bufsize=1, universal_newlines=True, encoding='utf-8') as p:
|
||||
for line in p.stdout:
|
||||
print(line, end='')
|
||||
|
||||
if p.returncode != 0:
|
||||
cli.log.error('git clone exited %d', p.returncode)
|
||||
return False
|
||||
else:
|
||||
cli.log.info('Successfully cloned %s to %s!', cli.args.fork, cli.args.destination)
|
||||
return True
|
||||
cli.log.info('Successfully cloned %s to %s!', url, destination)
|
||||
|
||||
return p.returncode
|
||||
|
||||
+4
-3
@@ -1,6 +1,6 @@
|
||||
"""Useful helper functions.
|
||||
"""
|
||||
from milc import cli
|
||||
from milc import cli, format_ansi
|
||||
|
||||
|
||||
def question(question, boolean=True, default=''):
|
||||
@@ -18,10 +18,11 @@ def question(question, boolean=True, default=''):
|
||||
else:
|
||||
answer_key = 'y/n'
|
||||
|
||||
prompt = '*** %s [%s] ' % (question, answer_key)
|
||||
prompt = format_ansi('\n*** %s [%s] ' % (question, answer_key))
|
||||
|
||||
while True:
|
||||
answer = input(prompt)
|
||||
print()
|
||||
if answer == '' and default.lower() == 'y':
|
||||
answer = 'y'
|
||||
elif answer == '' and default.lower() == 'n':
|
||||
@@ -32,4 +33,4 @@ def question(question, boolean=True, default=''):
|
||||
elif answer.lower() in ['n', 'no']:
|
||||
return False
|
||||
else:
|
||||
cli.args.echo('Invalid answer!')
|
||||
cli.echo('Invalid answer!')
|
||||
|
||||
+24
-6
@@ -2,9 +2,6 @@
|
||||
"""CLI wrapper for running QMK commands.
|
||||
|
||||
This program can be run from anywhere, with or without a qmk_firmware repository. If a qmk_firmware repository can be located we will use that to augment our available subcommands.
|
||||
|
||||
FIXME(skullydazed/anyone): --help shows underscores where we want dashes in subcommands (EG json_keymap instead of json-keymap)
|
||||
TODO(skullydazed/anyone): Need a way to filter some subcommands from --help (EG `qmk hello`)
|
||||
"""
|
||||
import argparse
|
||||
import os
|
||||
@@ -12,6 +9,7 @@ import subprocess
|
||||
import sys
|
||||
from functools import lru_cache
|
||||
from pathlib import Path
|
||||
import platform
|
||||
|
||||
import milc
|
||||
|
||||
@@ -32,8 +30,13 @@ def in_qmk_firmware():
|
||||
cur_dir = Path.cwd()
|
||||
while len(cur_dir.parents) > 0:
|
||||
found_bin = cur_dir / 'bin' / 'qmk'
|
||||
if found_bin.is_file():
|
||||
command = [found_bin.as_posix(), '--version']
|
||||
# An additional check for something that exists in the root of qmk_firmware,
|
||||
# but not in the script's install directory, to avoid recursive execution,
|
||||
# if started from install directory.
|
||||
# e.g.: cd ~/.local/bin && ./qmk
|
||||
found_quantum = cur_dir / 'quantum'
|
||||
if found_bin.is_file() and found_quantum.is_dir():
|
||||
command = [sys.executable, found_bin.as_posix()]
|
||||
result = subprocess.run(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||||
|
||||
if result.returncode == 0:
|
||||
@@ -67,6 +70,16 @@ def find_qmk_firmware():
|
||||
def main():
|
||||
"""Setup the environment before dispatching to the entrypoint.
|
||||
"""
|
||||
# Warn if they use an outdated python version
|
||||
if sys.version_info < (3, 6):
|
||||
print('Warning: Your Python version is out of date! Some subcommands may not work!')
|
||||
print('Please upgrade to Python 3.6 or later.')
|
||||
|
||||
if 'windows' in platform.platform().lower():
|
||||
if 'mingw64' not in sys.executable or 'mingw64' not in os.environ.get('MSYSTEM_PREFIX', ''):
|
||||
print('Warning: It seems you are not using the MINGW64 terminal.')
|
||||
print('While the MSYS one can work, too, we recommend/support you start "MSYS2 MinGW 64-bit".\n')
|
||||
|
||||
# Environment setup
|
||||
import qmk_cli
|
||||
milc.cli.version = qmk_cli.__version__
|
||||
@@ -80,7 +93,12 @@ def main():
|
||||
if qmk_firmware.exists():
|
||||
os.chdir(str(qmk_firmware))
|
||||
sys.path.append(str(qmk_firmware / 'lib' / 'python'))
|
||||
import qmk.cli
|
||||
try:
|
||||
import qmk.cli
|
||||
except ImportError:
|
||||
print('Error: %s is too old or not set up correctly!' % qmk_firmware)
|
||||
print('Please update it or remove it completely before continuing.')
|
||||
sys.exit(1)
|
||||
|
||||
# Call the entrypoint
|
||||
milc.cli()
|
||||
|
||||
@@ -4,7 +4,7 @@ import os
|
||||
from pathlib import Path
|
||||
|
||||
from milc import cli
|
||||
from qmk_cli.git import clone as git_clone
|
||||
from qmk_cli.git import git_clone
|
||||
|
||||
default_repo = 'qmk_firmware'
|
||||
default_fork = 'qmk/' + default_repo
|
||||
@@ -27,5 +27,4 @@ def clone(cli):
|
||||
cli.log.error('Destination already exists: %s', cli.args.destination)
|
||||
exit(1)
|
||||
|
||||
success = git_clone(git_url, cli.args.destination, cli.config.clone.branch)
|
||||
exit(0 if success else 1)
|
||||
return git_clone(git_url, cli.args.destination, cli.config.clone.branch)
|
||||
|
||||
@@ -1,12 +1,13 @@
|
||||
"""Setup qmk_firmware on your computer.
|
||||
"""
|
||||
import os
|
||||
import shlex
|
||||
import subprocess
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
from milc import cli
|
||||
from qmk_cli.git import clone
|
||||
from qmk_cli.git import git_clone
|
||||
from qmk_cli.helpers import question
|
||||
|
||||
default_repo = 'qmk_firmware'
|
||||
@@ -14,35 +15,48 @@ default_fork = 'qmk/' + default_repo
|
||||
default_branch = 'master'
|
||||
|
||||
|
||||
@cli.argument('-y', '--yes', action='store_true', help='Answer yes to all questions')
|
||||
@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='https://github.com', help='The URL all git operations start from')
|
||||
@cli.argument('-b', '--branch', default=default_branch, help='The branch to clone')
|
||||
@cli.argument('destination', default=os.environ['QMK_HOME'], nargs='?', help='The directory to clone to')
|
||||
@cli.argument('-H', '--home', default=Path(os.environ['QMK_HOME']), type=Path, help='The location for QMK Firmware. Defaults to %s' % (os.environ['QMK_HOME'],))
|
||||
@cli.argument('fork', default=default_fork, nargs='?', help='The qmk_firmware fork to clone')
|
||||
@cli.subcommand('Setup your computer for qmk_firmware.')
|
||||
def setup(cli):
|
||||
qmk_firmware = Path(cli.args.destination)
|
||||
"""Guide the user through setting up their QMK environment.
|
||||
"""
|
||||
clone_prompt = 'Would you like to clone {fg_cyan}%s{fg_reset} to {fg_cyan}%s{fg_reset}?' % (cli.args.fork, shlex.quote(str(cli.args.home)))
|
||||
home_prompt = 'Would you like to set {fg_cyan}%s{fg_reset} as your QMK home?' % (shlex.quote(str(cli.args.home)),)
|
||||
|
||||
# Sanity checks
|
||||
if cli.args.yes and cli.args.no:
|
||||
cli.log.error("Can't use both --yes and --no at the same time.")
|
||||
exit(1)
|
||||
|
||||
# Check on qmk_firmware, and if it doesn't exist offer to check it out.
|
||||
if qmk_firmware.exists():
|
||||
cli.log.info('Found qmk_firmware at %s.', str(qmk_firmware))
|
||||
if (cli.args.home / 'Makefile').exists():
|
||||
cli.log.info('Found qmk_firmware at %s.', str(cli.args.home))
|
||||
else:
|
||||
cli.log.error('qmk_firmware not found!')
|
||||
if question('Would you like to clone %s?' % cli.args.fork):
|
||||
cli.log.error('Could not find qmk_firmware!')
|
||||
if question(clone_prompt):
|
||||
git_url = '/'.join((cli.config.setup.baseurl, cli.args.fork))
|
||||
clone(git_url, cli.args.destination, cli.config.setup.branch)
|
||||
result = git_clone(git_url, cli.args.home, cli.config.setup.branch)
|
||||
if result != 0:
|
||||
exit(1)
|
||||
|
||||
# Offer to set `user.qmk_home` for them.
|
||||
if cli.args.home != os.environ['QMK_HOME'] and question(home_prompt):
|
||||
cli.config['user']['qmk_home'] = str(cli.args.home.absolute())
|
||||
cli.write_config_option('user', 'qmk_home')
|
||||
|
||||
# Run `qmk_firmware/bin/qmk doctor` to check the rest of the environment out
|
||||
if qmk_firmware.exists():
|
||||
qmk_bin = qmk_firmware / 'bin' / 'qmk'
|
||||
doctor = subprocess.run([sys.executable, qmk_bin, 'doctor'])
|
||||
if doctor.returncode != 0:
|
||||
cli.log.error('Your build environment is not setup completely.')
|
||||
qmk_bin = cli.args.home / 'bin/qmk'
|
||||
doctor_cmd = [sys.executable, qmk_bin, 'doctor']
|
||||
|
||||
if question('Would you like to run util/qmk_install?'):
|
||||
curdir = os.getcwd()
|
||||
os.chdir(str(qmk_firmware))
|
||||
process = subprocess.run(['util/qmk_install.sh'])
|
||||
os.chdir(curdir)
|
||||
if process.returncode == 0:
|
||||
cli.log.info('QMK setup complete!')
|
||||
if cli.args.yes:
|
||||
doctor_cmd.append('--yes')
|
||||
|
||||
if cli.args.no:
|
||||
doctor_cmd.append('--no')
|
||||
|
||||
subprocess.run(doctor_cmd)
|
||||
|
||||
@@ -12,7 +12,7 @@ TWINE_USERNAME=$PYPI_USERNAME
|
||||
|
||||
export FLIT_USERNAME TWINE_USERNAME
|
||||
|
||||
rm dist/*
|
||||
rm -f dist/*
|
||||
bumpversion patch
|
||||
git push origin master --tags
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
[bumpversion]
|
||||
current_version = 0.0.24
|
||||
current_version = 0.0.35
|
||||
commit = True
|
||||
tag = True
|
||||
tag_name = {new_version}
|
||||
|
||||
@@ -44,7 +44,9 @@ if __name__ == "__main__":
|
||||
"appdirs",
|
||||
"argcomplete",
|
||||
"colorama",
|
||||
"flake8",
|
||||
"hjson",
|
||||
"nose2",
|
||||
"yapf"
|
||||
],
|
||||
)
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
#!/bin/bash
|
||||
|
||||
cp -r $1 ~/qmk_cli
|
||||
|
||||
export PATH=~/.local/bin:$PATH
|
||||
echo "PATH=$PATH" >> ~/.bashrc
|
||||
|
||||
export QMK_HOME=~/qmk_firmware
|
||||
export CLI_DIR=~/qmk_cli
|
||||
|
||||
cd $CLI_DIR
|
||||
python3 -m pip install -r requirements.txt
|
||||
python3 setup.py sdist bdist_wheel
|
||||
cd ~
|
||||
python3 -m pip install --force-reinstall --no-index --no-deps --prefix=~/.local --find-links qmk_cli/dist qmk
|
||||
Reference in New Issue
Block a user