Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| be0dd95e46 | |||
| 30031a8cd7 | |||
| 94adba52c6 | |||
| 38aefc9716 |
+1
-1
@@ -1,3 +1,3 @@
|
|||||||
"""A program to help you work with qmk_firmware."""
|
"""A program to help you work with qmk_firmware."""
|
||||||
|
|
||||||
__version__ = '0.0.12'
|
__version__ = '0.0.14'
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
"""CLI wrapper for running QMK commands.
|
"""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)
|
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 subcommands`)
|
TODO(skullydazed/anyone): Need a way to filter some subcommands from --help (EG `qmk hello`)
|
||||||
"""
|
"""
|
||||||
import argparse
|
import argparse
|
||||||
import os
|
import os
|
||||||
@@ -61,20 +61,18 @@ def find_qmk_firmware():
|
|||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
"""Dispatch the CLI subcommand to the proper place.
|
"""Setup the environment before dispatching to the entrypoint.
|
||||||
|
|
||||||
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.
|
|
||||||
"""
|
"""
|
||||||
# Environment setup
|
# Environment setup
|
||||||
qmk_firmware = find_qmk_firmware()
|
qmk_firmware = find_qmk_firmware()
|
||||||
os.environ['QMK_HOME'] = str(qmk_firmware)
|
os.environ['QMK_HOME'] = str(qmk_firmware)
|
||||||
|
os.environ['ORIG_CWD'] = os.getcwd()
|
||||||
|
|
||||||
# Import the subcommand modules
|
# Import the subcommand modules
|
||||||
import qmk_cli.subcommands
|
import qmk_cli.subcommands
|
||||||
|
|
||||||
if qmk_firmware.exists():
|
if qmk_firmware.exists():
|
||||||
|
os.chdir(str(qmk_firmware))
|
||||||
sys.path.append(str(qmk_firmware / 'lib' / 'python'))
|
sys.path.append(str(qmk_firmware / 'lib' / 'python'))
|
||||||
import qmk.cli
|
import qmk.cli
|
||||||
|
|
||||||
|
|||||||
@@ -4,19 +4,22 @@ import os
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from milc import cli
|
from milc import cli
|
||||||
from qmk_cli.git import clone
|
from qmk_cli.git import clone as git_clone
|
||||||
|
|
||||||
default_repo = 'qmk_firmware'
|
default_repo = 'qmk_firmware'
|
||||||
default_fork = 'qmk/' + default_repo
|
default_fork = 'qmk/' + default_repo
|
||||||
default_branch = 'master'
|
default_branch = 'master'
|
||||||
|
|
||||||
|
|
||||||
@cli.argument('--baseurl', default='https://github.com', help='The URL all git operations start from.')
|
@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.')
|
@cli.argument('-b', '--branch', default=default_branch, help='The branch to clone (Default: %s)' % default_branch)
|
||||||
@cli.argument('destination', default=os.environ['QMK_HOME'], nargs='?', help='The directory to clone to.')
|
@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')
|
@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.')
|
@cli.subcommand('Clone a qmk_firmware fork.')
|
||||||
def clone(cli):
|
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)
|
qmk_firmware = Path(cli.args.destination)
|
||||||
git_url = '/'.join((cli.config.clone.baseurl, cli.args.fork))
|
git_url = '/'.join((cli.config.clone.baseurl, cli.args.fork))
|
||||||
|
|
||||||
@@ -24,5 +27,5 @@ def clone(cli):
|
|||||||
cli.log.error('Destination already exists: %s', cli.args.destination)
|
cli.log.error('Destination already exists: %s', cli.args.destination)
|
||||||
exit(1)
|
exit(1)
|
||||||
|
|
||||||
success = clone(git_url, cli.args.destination, cli.config.clone.branch)
|
success = git_clone(git_url, cli.args.destination, cli.config.clone.branch)
|
||||||
exit(0 if success else 1)
|
exit(0 if success else 1)
|
||||||
|
|||||||
Reference in New Issue
Block a user