| Name | qmk JSON |
| Version |
1.1.5
JSON |
| download |
| home_page | |
| Summary | A program to help users work with QMK Firmware. |
| upload_time | 2024-02-23 11:03:52 |
| maintainer | |
| docs_url | None |
| author | skullydazed |
| requires_python | >=3.7 |
| license | MIT License |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
* 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`
* Use `qmk console` to get debugging information from your keyboard(s)
* Check that your environment is correctly setup with `qmk doctor`
* Integrates with qmk_firmware for additional functionality:
* `qmk compile`
* `qmk info`
* `qmk flash`
* `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>
Raw data
{
"_id": null,
"home_page": "",
"name": "qmk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "skullydazed",
"author_email": "skullydazed@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/64/20/cec7ce9b7c05307209542427f417d005f082771596ab0f628f6a888b8aee/qmk-1.1.5.tar.gz",
"platform": null,
"description": "# QMK CLI\n[](https://github.com/qmk/qmk_cli/actions?query=workflow%3A%22CLI+Setup%22) \n\nA program to help users work with [QMK Firmware](https://qmk.fm/).\n\n# Features\n\n* Interact with your qmk_firmware tree from any location\n* Use `qmk clone` to pull down anyone's `qmk_firmware` fork\n* Setup your build environment with `qmk setup`\n* Use `qmk console` to get debugging information from your keyboard(s)\n* Check that your environment is correctly setup with `qmk doctor`\n* Integrates with qmk_firmware for additional functionality:\n * `qmk compile`\n * `qmk info`\n * `qmk flash`\n * `qmk lint`\n * ...and many more!\n\n# Packages\n\nWe provide \"install and go\" packages for many Operating Systems.\n\n## Linux\n\nPackages for several distributions available here: https://github.com/qmk/qmk_fpm\n\n## macOS\n\nUsing [Homebrew](https://brew.sh):\n\n brew install qmk/qmk/qmk\n\n## Windows\n\nDownload our custom MSYS2 installer here: https://msys.qmk.fm/\n\n# Quickstart\n\n* `python3 -m pip install qmk`\n* `qmk setup`\n\n# Building\n\nWe follow PEP517, you can install using [build](https://pypi.org/project/build/):\n\nSetup:\n\n python3 -m pip install build\n\nBuild:\n\n python3 -m build\n\nYou 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).\n\n# Documentation\n\nFull documentation: <https://docs.qmk.fm/#/tutorial>\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A program to help users work with QMK Firmware.",
"version": "1.1.5",
"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/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5294f762265378e3de9626b10bb2b277b33fd4e57285fbf3a2d0d9ff7a5bfcff",
"md5": "eb67db84b4b27046900c2bb8d0cae29e",
"sha256": "9c16fa2ad9b279ce9cc121a5462f02637611c6f54c49f9f2cac8ba2898f35b94"
},
"downloads": -1,
"filename": "qmk-1.1.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb67db84b4b27046900c2bb8d0cae29e",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 13808,
"upload_time": "2024-02-23T11:03:50",
"upload_time_iso_8601": "2024-02-23T11:03:50.565515Z",
"url": "https://files.pythonhosted.org/packages/52/94/f762265378e3de9626b10bb2b277b33fd4e57285fbf3a2d0d9ff7a5bfcff/qmk-1.1.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6420cec7ce9b7c05307209542427f417d005f082771596ab0f628f6a888b8aee",
"md5": "dd6a054abcd239626bed2300b1023ca0",
"sha256": "2efe3c752230c6ba24b8719c3b6e85a5644bf8f7d0dd237757eda9b7b7e60b11"
},
"downloads": -1,
"filename": "qmk-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "dd6a054abcd239626bed2300b1023ca0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12074,
"upload_time": "2024-02-23T11:03:52",
"upload_time_iso_8601": "2024-02-23T11:03:52.559462Z",
"url": "https://files.pythonhosted.org/packages/64/20/cec7ce9b7c05307209542427f417d005f082771596ab0f628f6a888b8aee/qmk-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-23 11:03:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qmk",
"github_project": "qmk_cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "qmk"
}
