New release: 0.0.26 → 0.0.27

* Remove the shadow argparser
* Make it easier to reason about arguments and how they're translated into the config tree
* Populate self.config during init to support setting user.qmk_home for the global CLI
* Remove the short argument -c so that we can unambiguously determine the config file location without doing full argument processing
* Remove the --save-config option as it's a little confusing anyway
* Use Pathlib for path manipulation

MANIFEST.in

@@ -1,5 +1,4 @@
 include *.md
-include *.toml
 include *.txt
 include LICENSE
 include qmk

milc.py

@@ -17,8 +17,10 @@ import argparse
 import logging
 import os
 import re
+import shlex
 import sys
 from decimal import Decimal
+from pathlib import Path
 from tempfile import NamedTemporaryFile
 from time import sleep
 
@@ -35,6 +37,10 @@ except ImportError:
 
 import argcomplete
 import colorama
+from appdirs import user_config_dir
+
+# Disable logging until we can configure it how the user wants
+logging.basicConfig(stream=os.devnull)
 
 # Log Level Representations
 EMOJI_LOGLEVELS = {
@@ -47,6 +53,7 @@ EMOJI_LOGLEVELS = {
 }
 EMOJI_LOGLEVELS['FATAL'] = EMOJI_LOGLEVELS['CRITICAL']
 EMOJI_LOGLEVELS['WARN'] = EMOJI_LOGLEVELS['WARNING']
+UNICODE_SUPPORT = sys.stdout.encoding.lower().startswith('utf')
 
 # ANSI Color setup
 # Regex was gratefully borrowed from kfir on stackoverflow:
@@ -90,25 +97,23 @@ def format_ansi(text):
 class ANSIFormatter(logging.Formatter):
     """A log formatter that inserts ANSI color.
     """
-
     def format(self, record):
         msg = super(ANSIFormatter, self).format(record)
         return format_ansi(msg)
 
 
 class ANSIEmojiLoglevelFormatter(ANSIFormatter):
-    """A log formatter that makes the loglevel an emoji.
+    """A log formatter that makes the loglevel an emoji on UTF capable terminals.
     """
-
     def format(self, record):
-        record.levelname = EMOJI_LOGLEVELS[record.levelname].format(**ansi_colors)
+        if UNICODE_SUPPORT:
+            record.levelname = EMOJI_LOGLEVELS[record.levelname].format(**ansi_colors)
         return super(ANSIEmojiLoglevelFormatter, self).format(record)
 
 
 class ANSIStrippingFormatter(ANSIFormatter):
     """A log formatter that strips ANSI.
     """
-
     def format(self, record):
         msg = super(ANSIStrippingFormatter, self).format(record)
         return ansi_escape.sub('', msg)
@@ -120,7 +125,6 @@ class Configuration(object):
     This class never raises IndexError, instead it will return None if a
     section or option does not yet exist.
     """
-
     def __contains__(self, key):
         return self._config.__contains__(key)
 
@@ -144,13 +148,15 @@ class Configuration(object):
 
     def __init__(self, *args, **kwargs):
         self._config = {}
-        self.default_container = ConfigurationOption
+
+    def __getattr__(self, key):
+        return self.__getitem__(key)
 
     def __getitem__(self, key):
         """Returns a config section, creating it if it doesn't exist yet.
         """
         if key not in self._config:
-            self.__dict__[key] = self._config[key] = ConfigurationOption()
+            self.__dict__[key] = self._config[key] = ConfigurationSection(self)
 
         return self._config[key]
 
@@ -161,30 +167,44 @@ class Configuration(object):
     def __delitem__(self, key):
         if key in self.__dict__ and key[0] != '_':
             del self.__dict__[key]
-        del self._config[key]
+        if key in self._config:
+            del self._config[key]
 
 
-class ConfigurationOption(Configuration):
-    def __init__(self, *args, **kwargs):
-        super(ConfigurationOption, self).__init__(*args, **kwargs)
-        self.default_container = dict
+class ConfigurationSection(Configuration):
+    def __init__(self, parent, *args, **kwargs):
+        super(ConfigurationSection, self).__init__(*args, **kwargs)
+        self.parent = parent
 
     def __getitem__(self, key):
-        """Returns a config section, creating it if it doesn't exist yet.
+        """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 not in self._config:
-            self.__dict__[key] = self._config[key] = None
+        if key in self._config and self._config.get(key) is not None:
+            return self._config[key]
 
-        return self._config[key]
+        elif key in self.parent.user:
+            return self.parent.user[key]
+
+        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'.
     """
-    kwargs['add_dest'] = False
     disabled_args = None
     disabled_kwargs = kwargs.copy()
     disabled_kwargs['action'] = 'store_false'
+    disabled_kwargs['dest'] = self.get_argument_name(*args, **kwargs)
     disabled_kwargs['help'] = 'Disable ' + kwargs['help']
     kwargs['action'] = 'store_true'
     kwargs['help'] = 'Enable ' + kwargs['help']
@@ -201,9 +221,8 @@ def handle_store_boolean(self, *args, **kwargs):
 
 
 class SubparserWrapper(object):
-    """Wrap subparsers so we can populate the normal and the shadow parser.
+    """Wrap subparsers so we can track what options the user passed.
     """
-
     def __init__(self, cli, submodule, subparser):
         self.cli = cli
         self.submodule = submodule
@@ -219,31 +238,30 @@ class SubparserWrapper(object):
         self.subparser.completer = completer
 
     def add_argument(self, *args, **kwargs):
-        if kwargs.get('add_dest', True):
-            kwargs['dest'] = self.submodule + '_' + self.cli.get_argument_name(*args, **kwargs)
-        if 'add_dest' in kwargs:
-            del kwargs['add_dest']
+        """Add an argument for this subcommand.
 
+        This also stores the default for the argument in `self.cli.default_arguments`.
+        """
         if 'action' in kwargs and kwargs['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()
         self.subparser.add_argument(*args, **kwargs)
-
-        if 'default' in kwargs:
-            del kwargs['default']
-        if 'action' in kwargs and kwargs['action'] == 'store_false':
-            kwargs['action'] == 'store_true'
-        self.cli.subcommands_default[self.submodule].add_argument(*args, **kwargs)
+        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.release_lock()
 
 
 class MILC(object):
     """MILC - An Opinionated Batteries Included Framework
     """
-
     def __init__(self):
         """Initialize the MILC object.
+
+            version
+                The version string to associate with your CLI program
         """
         # Setup a lock for thread safety
         self._lock = threading.RLock() if thread else None
@@ -254,13 +272,19 @@ class MILC(object):
         self._entrypoint = None
         self._inside_context_manager = False
         self.ansi = ansi_colors
-        self.config = Configuration()
+        self.arg_only = []
+        self.config = None
         self.config_file = None
-        self.prog_name = sys.argv[0][:-3] if sys.argv[0].endswith('.py') else sys.argv[0]
-        self.version = os.environ.get('QMK_VERSION', 'unknown')
+        self.default_arguments = {}
+        self.version = 'unknown'
         self.release_lock()
 
+        # Figure out our program name
+        self.prog_name = sys.argv[0][:-3] if sys.argv[0].endswith('.py') else sys.argv[0]
+        self.prog_name = self.prog_name.split('/')[-1]
+
         # Initialize all the things
+        self.read_config_file()
         self.initialize_argparse()
         self.initialize_logging()
 
@@ -270,10 +294,10 @@ class MILC(object):
 
     @description.setter
     def description(self, value):
-        self._description = self._arg_parser.description = self._arg_defaults.description = value
+        self._description = self._arg_parser.description = value
 
     def echo(self, text, *args, **kwargs):
-        """Print colorized text to stdout, as long as stdout is a tty.
+        """Print colorized text to stdout.
 
         ANSI color strings (such as {fg-blue}) will be converted into ANSI
         escape sequences, and the ANSI reset sequence will be added to all
@@ -284,11 +308,10 @@ class MILC(object):
         if args and kwargs:
             raise RuntimeError('You can only specify *args or **kwargs, not both!')
 
-        if sys.stdout.isatty():
-            args = args or kwargs
-            text = format_ansi(text)
+        args = args or kwargs
+        text = format_ansi(text)
 
-            print(text % args)
+        print(text % args)
 
     def initialize_argparse(self):
         """Prepare to process arguments from sys.argv.
@@ -300,12 +323,9 @@ class MILC(object):
 
         self.acquire_lock()
         self.subcommands = {}
-        self.subcommands_default = {}
         self._subparsers = None
-        self._subparsers_default = None
         self.argwarn = argcomplete.warn
         self.args = None
-        self._arg_defaults = argparse.ArgumentParser(**kwargs)
         self._arg_parser = argparse.ArgumentParser(**kwargs)
         self.set_defaults = self._arg_parser.set_defaults
         self.print_usage = self._arg_parser.print_usage
@@ -313,30 +333,23 @@ class MILC(object):
         self.release_lock()
 
     def completer(self, completer):
-        """Add an arpcomplete completer to this subcommand.
+        """Add an argcomplete completer to this subcommand.
         """
         self._arg_parser.completer = completer
 
     def add_argument(self, *args, **kwargs):
-        """Wrapper to add arguments to both the main and the shadow argparser.
+        """Wrapper to add arguments and track whether they were passed on the command line.
         """
-        if kwargs.get('add_dest', True) and args[0][0] == '-':
-            kwargs['dest'] = 'general_' + self.get_argument_name(*args, **kwargs)
-        if 'add_dest' in kwargs:
-            del kwargs['add_dest']
-
         if 'action' in kwargs and kwargs['action'] == 'store_boolean':
             return handle_store_boolean(self, *args, **kwargs)
 
         self.acquire_lock()
-        self._arg_parser.add_argument(*args, **kwargs)
 
-        # Populate the shadow parser
-        if 'default' in kwargs:
-            del kwargs['default']
-        if 'action' in kwargs and kwargs['action'] == 'store_false':
-            kwargs['action'] == 'store_true'
-        self._arg_defaults.add_argument(*args, **kwargs)
+        self._arg_parser.add_argument(*args, **kwargs)
+        if 'general' not in self.default_arguments:
+            self.default_arguments['general'] = {}
+        self.default_arguments['general'][self.get_argument_name(*args, **kwargs)] = kwargs.get('default')
+
         self.release_lock()
 
     def initialize_logging(self):
@@ -363,15 +376,14 @@ class MILC(object):
         self.add_argument('--log-file-fmt', default='[%(levelname)s] [%(asctime)s] [file:%(pathname)s] [line:%(lineno)d] %(message)s', help='Format string for log file.')
         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('-c', '--config-file', help='The config file to read and/or write')
-        self.add_argument('--save-config', action='store_true', help='Save the running configuration to the config file')
+        self.add_argument('--config-file', help='The location for the configuration file')
+        self.arg_only.append('config_file')
 
     def add_subparsers(self, title='Sub-commands', **kwargs):
         if self._inside_context_manager:
             raise RuntimeError('You must run this before the with statement!')
 
         self.acquire_lock()
-        self._subparsers_default = self._arg_defaults.add_subparsers(title=title, dest='subparsers', **kwargs)
         self._subparsers = self._arg_parser.add_subparsers(title=title, dest='subparsers', **kwargs)
         self.release_lock()
 
@@ -393,10 +405,12 @@ class MILC(object):
         if self.config_file:
             return self.config_file
 
-        if self.args and self.args.general_config_file:
-            return self.args.general_config_file
+        if '--config-file' in sys.argv:
+            return Path(sys.argv[sys.argv.index('--config-file') + 1]).expanduser().resolve()
 
-        return os.path.abspath(os.path.expanduser('~/.%s.ini' % self.prog_name))
+        filedir = user_config_dir(appname='qmk', appauthor='QMK')
+        filename = '%s.ini' % self.prog_name
+        return Path(filedir) / filename
 
     def get_argument_name(self, *args, **kwargs):
         """Takes argparse arguments and returns the dest name.
@@ -413,11 +427,17 @@ 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']:
+                arg_name = self.get_argument_name(*args, **kwargs)
+                self.arg_only.append(arg_name)
+                del kwargs['arg_only']
+
+            name = handler.__name__.replace("_", "-")
             if handler is self._entrypoint:
                 self.add_argument(*args, **kwargs)
 
-            elif handler.__name__ in self.subcommands:
-                self.subcommands[handler.__name__].add_argument(*args, **kwargs)
+            elif name in self.subcommands:
+                self.subcommands[name].add_argument(*args, **kwargs)
 
             else:
                 raise RuntimeError('Decorated function is not entrypoint or subcommand!')
@@ -429,7 +449,7 @@ class MILC(object):
     def arg_passed(self, arg):
         """Returns True if arg was passed on the command line.
         """
-        return self.args_passed[arg] in (None, False)
+        return self.default_arguments.get(arg) != self.args[arg]
 
     def parse_args(self):
         """Parse the CLI args.
@@ -442,25 +462,22 @@ class MILC(object):
 
         self.acquire_lock()
         self.args = self._arg_parser.parse_args()
-        self.args_passed = self._arg_defaults.parse_args()
 
         if 'entrypoint' in self.args:
             self._entrypoint = self.args.entrypoint
 
-        if self.args.general_config_file:
-            self.config_file = self.args.general_config_file
-
         self.release_lock()
 
-    def read_config(self):
-        """Parse the configuration file and determine the runtime configuration.
+    def read_config_file(self):
+        """Read in the configuration file and store it in self.config.
         """
         self.acquire_lock()
+        self.config = Configuration()
         self.config_file = self.find_config_file()
 
-        if self.config_file and os.path.exists(self.config_file):
+        if self.config_file and self.config_file.exists():
             config = RawConfigParser(self.config)
-            config.read(self.config_file)
+            config.read(str(self.config_file))
 
             # Iterate over the config file options and write them into self.config
             for section in config.sections():
@@ -470,8 +487,10 @@ class MILC(object):
                     # Coerce values into useful datatypes
                     if value.lower() in ['1', 'yes', 'true', 'on']:
                         value = True
-                    elif value.lower() in ['0', 'no', 'false', 'none', 'off']:
+                    elif value.lower() in ['0', 'no', 'false', 'off']:
                         value = False
+                    elif value.lower() in ['none']:
+                        continue
                     elif value.replace('.', '').isdigit():
                         if '.' in value:
                             value = Decimal(value)
@@ -480,27 +499,50 @@ class MILC(object):
 
                     self.config[section][option] = value
 
-        # Fold the CLI args into self.config
+        self.release_lock()
+
+    def merge_args_into_config(self):
+        """Merge CLI arguments into self.config to create the runtime configuration.
+        """
+        self.acquire_lock()
         for argument in vars(self.args):
             if argument in ('subparsers', 'entrypoint'):
                 continue
 
-            if '_' not in argument:
-                continue
+            if argument not in self.arg_only:
+                # 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'
 
-            section, option = argument.split('_', 1)
-            if hasattr(self.args_passed, argument):
-                self.config[section][option] = getattr(self.args, argument)
-            else:
-                if option not in self.config[section]:
-                    self.config[section][option] = getattr(self.args, argument)
+                if not argument_found:
+                    raise RuntimeError('Could not find argument in `self.default_arguments`. This should be impossible!')
+                    exit(1)
+
+                # Merge this argument into self.config
+                if argument in self.default_arguments['general'] or argument in self.default_arguments[entrypoint_name]:
+                    arg_value = getattr(self.args, argument)
+                    if arg_value is not None:
+                        self.config[section][argument] = arg_value
+                else:
+                    if argument not in self.config[entrypoint_name]:
+                        # Check if the argument exist for this section
+                        arg = getattr(self.args, argument)
+                        if arg is not None:
+                            self.config[section][argument] = arg
 
         self.release_lock()
 
     def save_config(self):
         """Save the current configuration to the config file.
         """
-        self.log.debug("Saving config file to '%s'", self.config_file)
+        self.log.debug("Saving config file to '%s'", str(self.config_file))
 
         if not self.config_file:
             self.log.warning('%s.config_file file not set, not saving config!', self.__class__.__name__)
@@ -508,25 +550,34 @@ class MILC(object):
 
         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 ['save_config']:
+                    if option_name in ['config_file']:
                         continue
-                config.set(section_name, option_name, str(value))
+                if value is not None:
+                    config.set(section_name, option_name, str(value))
 
-        with NamedTemporaryFile(mode='w', dir=os.path.dirname(self.config_file), delete=False) as tmpfile:
+        # 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, self.config_file)
+            os.rename(tmpfile.name, str(self.config_file))
         else:
-            self.log.warning('Config file saving failed, not replacing %s with %s.', self.config_file, tmpfile.name)
+            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)))
 
     def __call__(self):
         """Execute the entrypoint function.
@@ -534,8 +585,7 @@ class MILC(object):
         if not self._inside_context_manager:
             # If they didn't use the context manager use it ourselves
             with self:
-                self.__call__()
-                return
+                return self.__call__()
 
         if not self._entrypoint:
             raise RuntimeError('No entrypoint provided!')
@@ -561,41 +611,37 @@ 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__
+            name = handler.__name__.replace("_", "-")
 
         self.acquire_lock()
-        kwargs['help'] = description
-        self.subcommands_default[name] = self._subparsers_default.add_parser(name, **kwargs)
+        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)
 
-        if name not in self.__dict__:
-            self.__dict__[name] = self.subcommands[name]
-        else:
-            self.log.debug("Could not add subcommand '%s' to attributes, key already exists!", name)
-
         self.release_lock()
 
         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
 
@@ -603,8 +649,8 @@ class MILC(object):
         """Called by __enter__() to setup the logging configuration.
         """
         if len(logging.root.handlers) != 0:
-            # This is not a design decision. This is what I'm doing for now until I can examine and think about this situation in more detail.
-            raise RuntimeError('MILC should be the only system installing root log handlers!')
+            # MILC is the only thing that should have root log handlers
+            logging.root.handlers = []
 
         self.acquire_lock()
 
@@ -617,9 +663,9 @@ class MILC(object):
         self.log_format = self.config['general']['log_fmt']
 
         if self.config.general.color:
-            self.log_format = ANSIEmojiLoglevelFormatter(self.args.general_log_fmt, self.config.general.datetime_fmt)
+            self.log_format = ANSIEmojiLoglevelFormatter(self.args.log_fmt, self.config.general.datetime_fmt)
         else:
-            self.log_format = ANSIStrippingFormatter(self.args.general_log_fmt, self.config.general.datetime_fmt)
+            self.log_format = ANSIStrippingFormatter(self.args.log_fmt, self.config.general.datetime_fmt)
 
         if self.log_file:
             self.log_file_handler = logging.FileHandler(self.log_file, self.log_file_mode)
@@ -646,12 +692,9 @@ class MILC(object):
 
         colorama.init()
         self.parse_args()
-        self.read_config()
+        self.merge_args_into_config()
         self.setup_logging()
 
-        if self.config.general.save_config:
-            self.save_config()
-
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
@@ -713,4 +756,3 @@ if __name__ == '__main__':
     cli.goodbye.add_argument('-n', '--name', help='Name to bid farewell to', default='World')
 
     cli()  # Automatically picks between main(), hello() and goodbye()
-    print(sorted(ansi_colors.keys()))

pyproject.toml

@@ -1,40 +0,0 @@
-#[build-system]
-# Use setuptools for now until this PR is merged and available in homebrew:
-#
-#     https://github.com/pypa/pip/pull/6606
-#
-# We still pull our build metadata from this file so we can easily go back to flit.
-#
-#requires = ["flit"]
-#build-backend = "flit.buildapi"
-
-[tool.flit.metadata]
-dist-name = "qmk"
-module = "qmk_cli"
-author = "skullydazed"
-author-email = "skullydazed@gmail.com"
-description-file = "README.md"
-home-page = "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',
-]
-requires-python = ">=3.5"
-requires = [
-    #"milc", #FIXME(skullydazed): Included in the repo for now.
-    "argcomplete",
-    "colorama",
-    #"halo"
-]
-
-[tool.flit.scripts]
-qmk = "qmk_cli.script_qmk:main"

qmk_cli/__init__.py

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

qmk_cli/doctor.py

@@ -1,96 +0,0 @@
-"""QMK Python Doctor
-
-Check up for QMK environment.
-"""
-import shutil
-import platform
-import os
-from pathlib import Path
-
-from qmk_cli.milc import cli
-
-
-def check_qmk_firmware():
-    """Make sure qmk_firmware and the qmk cli are there.
-    """
-    qmk_firmware = Path(os.environ['QMK_HOME'])
-    qmk_cli = qmk_firmware / 'bin' / 'qmk'
-
-    if qmk_firmware.exists() and not qmk_cli.exists():
-        cli.log.error("{fg_red}Can't find %s/bin/qmk! You need to `git pull`.", os.environ['QMK_HOME'])
-        return False
-
-    elif not qmk_firmware.exists():
-        cli.log.error("{fg_red}Can't find the qmk_firmware checkout! %s does not exist!", os.environ['QMK_HOME'])
-        return False
-
-    cli.log.info('Found qmk_firmware checkout in {fg_cyan}%s', str(qmk_firmware))
-    return True
-
-
-def check_vital_programs():
-    """Make sure the software we need has been installed.
-
-    TODO(unclaimed):
-        * [ ] Run the binaries to make sure they work
-        * [ ] Compile a trivial program with each compiler
-    """
-    ok = True
-    binaries = ['dfu-programmer', 'avrdude', 'dfu-util', 'avr-gcc', 'arm-none-eabi-gcc']
-
-    for binary in binaries:
-        res = shutil.which(binary)
-        if res is None:
-            cli.log.error("{fg_red}QMK can't find %s in your path", binary)
-            ok = False
-
-    if ok:
-        cli.log.info("All necessary software is installed.")
-
-    return ok
-
-
-def check_platform_tests():
-    """Dispatch to platform specific tests.
-    """
-    OS = platform.system()
-
-    if OS == "Darwin":
-        cli.log.info("Detected {fg_cyan}macOS")
-        return check_mac_os()
-
-    elif OS == "Linux":
-        cli.log.info("Detected {fg_cyan}linux")
-        return check_linux()
-
-    else:
-        cli.log.info("Assuming {fg_cyan}Windows")
-        return check_windows()
-
-
-def check_mac_os():
-    """Run macOS specific tests.
-
-    There aren't any yet.
-    """
-    return True
-
-
-def check_linux():
-    """Run Linux specific tests.
-
-    TODO(unclaimed):
-        * [ ] Check for udev entries on linux
-    """
-    test = 'systemctl list-unit-files | grep enabled | grep -i ModemManager'
-    if os.system(test) == 0:
-        cli.log.warn("{bg_yellow}Detected modem manager. Please disable it if you are using Pro Micros")
-
-
-def check_windows():
-    """Run Windows specific tests.
-
-    TODO(unclaimed):
-        * [ ] Check out the driver situation
-    """
-    return True

qmk_cli/git.py

@@ -2,7 +2,7 @@
 """
 import subprocess
 
-from qmk_cli.milc import cli
+from milc import cli
 
 default_repo = 'qmk_firmware'
 default_fork = 'qmk/' + default_repo

qmk_cli/helpers.py

@@ -1,6 +1,6 @@
 """Useful helper functions.
 """
-from qmk_cli.milc import cli
+from milc import cli
 
 
 def question(question, boolean=True, default=''):
@@ -8,7 +8,7 @@ def question(question, boolean=True, default=''):
 
     This keeps re-asking until it gets acceptible input.
     """
-    if cli.args.general_yes:
+    if cli.args.yes:
         return True
 
     if default and default.lower() == 'y':

qmk_cli/script_qmk.py

@@ -1,16 +1,29 @@
 #!/usr/bin/env python3
 """CLI wrapper for running QMK commands.
 
-This program can be run from anywhere, with or without a qmk_firmware checkout. It provides a small set of subcommands for working with QMK and otherwise dispatches to the `qmk_firmware/bin/qmk` script for the repo you are currently in, or your default repo if you are not currently in a qmk_firmware checkout.
+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
 import subprocess
 import sys
 from functools import lru_cache
-from importlib import import_module
 from pathlib import Path
 
+import milc
+
+milc.EMOJI_LOGLEVELS['INFO'] = '{fg_blue}Ψ{style_reset_all}'
+
+
+@milc.cli.entrypoint('CLI wrapper for running QMK commands.')
+def qmk_main(cli):
+    """The function that gets run when there's no subcommand.
+    """
+    cli.print_help()
+
 
 @lru_cache(maxsize=2)
 def in_qmk_firmware():
@@ -20,8 +33,8 @@ def in_qmk_firmware():
     while len(cur_dir.parents) > 0:
         found_bin = cur_dir / 'bin' / 'qmk'
         if found_bin.is_file():
-            command = [found_bin, '--version']
-            result = subprocess.run(command)
+            command = [found_bin.as_posix(), '--version']
+            result = subprocess.run(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 
             if result.returncode == 0:
                 return cur_dir
@@ -35,67 +48,39 @@ def find_qmk_firmware():
     """Look for qmk_firmware in the usual places.
 
     This function returns the path to qmk_firmware, or the default location if one does not exist.
-
-    FIXME(skullydazed): add config file support
     """
     if in_qmk_firmware():
         return in_qmk_firmware()
 
+    if milc.cli.config.user.qmk_home:
+        return Path(milc.cli.config.user.qmk_home).expanduser().resolve()
+
     if 'QMK_HOME' in os.environ:
-        return Path(os.environ['QMK_HOME'])
+        path = Path(os.environ['QMK_HOME']).expanduser()
+        if path.exists():
+            return path.resolve()
+        return path
 
     return Path.home() / 'qmk_firmware'
 
 
-def parse_args():
-    """Process arguments outside milc.
-    """
-    parser = argparse.ArgumentParser(description='CLI wrapper for running QMK commands.')
-    parser.add_argument('-H', '--home', help='Path to the qmk_firmware directory.')
-    parser.add_argument('subcommand', help='Subcommand to run')
-    parser.add_argument('subcommand_args', nargs=argparse.REMAINDER, help='Arguments to pass to the subcommand.')
-    args = parser.parse_args()
-
-    if args.home:
-        os.environ['QMK_HOME'] = args.home
-
-    return (args.subcommand, args.subcommand_args)
-
-
 def main():
-    """Dispatch the CLI subcommand to the proper place.
-
-    We first check to see if the subcommand was provided by the global `qmk`. If it was we import that module and hand control over to the entrypoint.
-
-    All other subcommands are dispatched to the local `qmk`, either the one we are currently in or whatever the user's default qmk_firmware is.
+    """Setup the environment before dispatching to the entrypoint.
     """
-    subcommand, subcommand_args = parse_args()
-    subcommand_module = 'qmk_cli.subcommands.' + subcommand
-    sys.argv = ['qmk-'+subcommand] + subcommand_args
+    # Environment setup
+    import qmk_cli
+    milc.cli.version = qmk_cli.__version__
     qmk_firmware = find_qmk_firmware()
-    qmk_bin = qmk_firmware / 'bin' / 'qmk'
     os.environ['QMK_HOME'] = str(qmk_firmware)
+    os.environ['ORIG_CWD'] = os.getcwd()
 
-    try:
-        # Attempt to import the subcommand from qmk_cli first
-        import qmk_cli.milc
-        import_module(subcommand_module)
-        qmk_cli.milc.cli()
+    # Import the subcommand modules
+    import qmk_cli.subcommands
 
-    except ImportError as e:
-        # Check to make sure there's not a bad import statement in qmk_cli
-        if e.name != subcommand_module:
-            raise
+    if qmk_firmware.exists():
+        os.chdir(str(qmk_firmware))
+        sys.path.append(str(qmk_firmware / 'lib' / 'python'))
+        import qmk.cli
 
-        # Dispatch to the underlying `qmk_firmware/bin/qmk`
-        if qmk_bin.is_file() and os.access(str(qmk_bin), os.X_OK):
-            argv = ['python3', str(qmk_bin), subcommand] + subcommand_args
-            os.execvp('python3', argv)
-
-        # Tell the user we can't continue
-        print('*** Could not locate qmk_firmware directory!')
-        exit(255)
-
-
-if __name__ == '__main__':
-    main()
+    # Call the entrypoint
+    milc.cli()

qmk_cli/subcommands/__init__.py

@@ -0,0 +1,6 @@
+"""QMK CLI Subcommands
+
+We list each subcommand here explicitly because all the reliable ways of searching for modules are slow and delay startup.
+"""
+from . import clone
+from . import setup

qmk_cli/subcommands/clone.py

@@ -3,26 +3,29 @@
 import os
 from pathlib import Path
 
-from qmk_cli.milc import cli
-from qmk.cli.git import clone
+from milc import cli
+from qmk_cli.git import clone as git_clone
 
 default_repo = 'qmk_firmware'
 default_fork = 'qmk/' + default_repo
 default_branch = 'master'
 
 
-@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('fork', default=default_fork, nargs='?', help='The qmk_firmware fork to clone')
-@cli.entrypoint('Clone a qmk_firmware fork.')
-def main(cli):
+@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.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.general.baseurl, cli.args.fork))
+    git_url = '/'.join((cli.config.clone.baseurl, cli.args.fork))
 
     if qmk_firmware.exists():
         cli.log.error('Destination already exists: %s', cli.args.destination)
         exit(1)
 
-    success = clone(git_url, cli.args.destination, cli.config.general.branch)
+    success = git_clone(git_url, cli.args.destination, cli.config.clone.branch)
     exit(0 if success else 1)

qmk_cli/subcommands/doctor.py

@@ -1,29 +0,0 @@
-"""QMK Python Doctor
-
-Check up for QMK environment.
-"""
-import qmk_cli.doctor
-from qmk_cli.milc import cli
-
-
-@cli.entrypoint('Basic QMK environment checks')
-def main(cli):
-    """Basic QMK environment checks.
-
-    This is currently very simple, it just checks that all the expected binaries are on your system.
-    """
-    cli.log.info('QMK Doctor is checking your environment')
-
-    funcs = (
-        qmk_cli.doctor.check_qmk_firmware,
-        qmk_cli.doctor.check_vital_programs,
-        qmk_cli.doctor.check_platform_tests,
-    )
-
-    ok = True
-    for func in funcs:
-        if not func():
-            ok = False
-
-    if ok:
-        cli.log.info('{fg_green}QMK is ready to go')

qmk_cli/subcommands/setup.py

@@ -2,12 +2,12 @@
 """
 import os
 import subprocess
+import sys
 from pathlib import Path
 
-from qmk_cli.doctor import check_vital_programs
+from milc import cli
 from qmk_cli.git import clone
 from qmk_cli.helpers import question
-from qmk_cli.milc import cli
 
 default_repo = 'qmk_firmware'
 default_fork = 'qmk/' + default_repo
@@ -19,9 +19,8 @@ default_branch = 'master'
 @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('fork', default=default_fork, nargs='?', help='The qmk_firmware fork to clone')
-@cli.entrypoint('Setup your computer for qmk_firmware.')
-def main(cli):
-    setup_successful = False
+@cli.subcommand('Setup your computer for qmk_firmware.')
+def setup(cli):
     qmk_firmware = Path(cli.args.destination)
 
     # Check on qmk_firmware, and if it doesn't exist offer to check it out.
@@ -30,22 +29,20 @@ def main(cli):
     else:
         cli.log.error('qmk_firmware not found!')
         if question('Would you like to clone %s?' % cli.args.fork):
-            git_url = '/'.join((cli.config.general.baseurl, cli.args.fork))
-            clone(git_url, cli.args.destination, cli.config.general.branch)
+            git_url = '/'.join((cli.config.setup.baseurl, cli.args.fork))
+            clone(git_url, cli.args.destination, cli.config.setup.branch)
 
-    # Check if the build environment is setup, and if not offer to set it up
-    if check_vital_programs():
-        cli.log.info('Your build environment is ready!')
-    else:
-        cli.log.error('Your build environment is not setup completely.')
-        if qmk_firmware.exists() and 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:
-                setup_successful = True
+    # 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.')
 
-    # fin
-    if setup_successful:
-        cli.log.info('QMK setup complete!')
+            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!')

release

@@ -1,12 +1,18 @@
 #!/bin/sh
 # Increment the verison number and release a new version of qmk_cli.
+#
+# Required packages: pip3 install bumpversion twine
+
 set -e
 set -x
 
-FLIT_USERNAME=${FLIT_USERNAME:=skully}
+PYPI_USERNAME=${PYPI_USERNAME:=skully}
+FLIT_USERNAME=$PYPI_USERNAME
+TWINE_USERNAME=$PYPI_USERNAME
 
-export FLIT_USERNAME
+export FLIT_USERNAME TWINE_USERNAME
 
+rm dist/*
 bumpversion patch
 git push origin master --tags
 

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.6
+current_version = 0.0.27
 commit = True
 tag = True
 tag_name = {new_version}
@@ -16,7 +16,17 @@ universal = 1
 ignore = E501,E226
 
 [metadata]
+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.5
+
+[entry_points]
+qmk = qmk_cli.script_qmk:main
 
 [yapf]
 align_closing_bracket_with_visual_indent = True

setup.py

@@ -1,19 +1,18 @@
 from configparser import ConfigParser
 from setuptools import setup, find_packages
 
-import toml
-
 setup_cfg = ConfigParser()
 setup_cfg.read('setup.cfg')
-pyproject = toml.load('pyproject.toml')
-metadata = pyproject['tool']['flit']['metadata']
+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=open(metadata['description-file']).read(),
+        description='A program to help users work with QMK Firmware.',
         entry_points={
-            'console_scripts': ['%s = %s' % l for l in pyproject['tool']['flit']['scripts'].items()]
+            'console_scripts': ['%s = %s' % l for l in setup_cfg['entry_points'].items()],
         },
         license='MIT License',
         url=metadata['home-page'],
@@ -22,9 +21,31 @@ if __name__ == "__main__":
         author_email=metadata['author-email'],
         maintainer=metadata['author'],
         maintainer_email=metadata['author-email'],
-        long_description=open('README.md').read(),
+        long_description=long_description,
         long_description_content_type="text/markdown",
         packages=find_packages(),
-        classifiers=metadata['classifiers'],
-        install_requires=metadata['requires'],
+        py_modules = ['milc'],
+        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',
+        ],
+        requires_python=metadata['requires-python'],
+        install_requires=[
+            #"milc", #FIXME(skullydazed): Included in the repo for now.
+            "appdirs",
+            "argcomplete",
+            "colorama",
+            "flake8",
+            "hjson",
+            "yapf"
+        ],
     )