Metadata-Version: 2.1
Name: qmk
Version: 0.2.1
Summary: A program to help users work with QMK Firmware.
Home-page: https://github.com/qmk/qmk_cli
Author: skullydazed
Author-email: skullydazed@gmail.com
Maintainer: skullydazed
Maintainer-email: skullydazed@gmail.com
License: MIT License
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: appdirs (==1.4.4)
Requires-Dist: argcomplete (==1.12.3)
Requires-Dist: attrs (==21.2.0)
Requires-Dist: colorama (==0.4.4)
Requires-Dist: coverage (==5.5)
Requires-Dist: qmk-dotty-dict (==1.3.0.post1)
Requires-Dist: flake8 (==3.9.2)
Requires-Dist: halo (==0.0.31)
Requires-Dist: hid (==1.0.4)
Requires-Dist: hjson (==3.0.2)
Requires-Dist: jsonschema (==3.2.0)
Requires-Dist: log-symbols (==0.0.14)
Requires-Dist: mccabe (==0.6.1)
Requires-Dist: milc (==1.4.2)
Requires-Dist: nose2 (==0.10.0)
Requires-Dist: pycodestyle (==2.7.0)
Requires-Dist: pyflakes (==2.3.1)
Requires-Dist: Pygments (==2.9.0)
Requires-Dist: pyrsistent (==0.18.0)
Requires-Dist: pyusb (==1.2.1)
Requires-Dist: setuptools (>=45)
Requires-Dist: six (==1.16.0)
Requires-Dist: spinners (==0.0.24)
Requires-Dist: termcolor (==1.1.0)
Requires-Dist: yapf (==0.31.0)

# QMK CLI
[![CLI Setup](https://github.com/qmk/qmk_cli/workflows/CLI%20Setup/badge.svg)](https://github.com/qmk/qmk_cli/actions?query=workflow%3A%22CLI+Setup%22)  

A program to help users work with [QMK Firmware](https://qmk.fm/).

# Features

* Interact with your qmk_firmware tree from any location
* Use `qmk clone` to pull down anyone's `qmk_firmware` fork
* Setup your build environment with `qmk setup`
* Check that your environment is correctly setup with `qmk doctor`
* Integrates with qmk_firmware for additional functionality:
    * `qmk compile`
    * `qmk console`
    * `qmk flash`
    * `qmk lint`
    * ...and many more!

# Quickstart

* `python3 -m pip install qmk`
* `qmk setup`

Full documentation: <https://docs.qmk.fm/#/tutorial>


