{ "info": { "author": "yskoht", "author_email": "ysk.oht@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# Keymapviz\n\n[![Python Version](https://img.shields.io/badge/Python-3.x-blue.svg)](PythonVersion)\n[![MIT License](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE)\n\nKeymapviz can convert keymap.c in [qmk_firmware](https://github.com/qmk/qmk_firmware) to ascii art or json file.\n\nFollowing keyboards are supported.\n\n- [crkbd](https://github.com/qmk/qmk_firmware/tree/master/keyboards/crkbd)\n- [ergo42](https://github.com/qmk/qmk_firmware/tree/master/keyboards/ergo42)\n- [ergodash](https://github.com/qmk/qmk_firmware/tree/master/keyboards/ergodash)\n- [ergodox_ez](https://github.com/qmk/qmk_firmware/tree/master/keyboards/ergodox_ez)(ergodox)\n- [fortitude60](https://github.com/qmk/qmk_firmware/tree/master/keyboards/fortitude60)\n- [helix](https://github.com/qmk/qmk_firmware/tree/master/keyboards/helix)\n- [kinesis](https://github.com/qmk/qmk_firmware/tree/master/keyboards/kinesis)\n- [lets_split](https://github.com/qmk/qmk_firmware/tree/master/keyboards/lets_split)\n- [mint60](https://github.com/qmk/qmk_firmware/tree/master/keyboards/mint60)\n\n## Install\n\nKeymapviz works with ***Python3***.\n\n```sh\n$ pip3 install keymapviz\n```\n\n## Usage\n\nOutput ascii art.\n\n```sh\n$ keymapviz qmk_firmware/keyboards/ergodox_ez/keymaps/default/keymap.c\n\n/*\n *\n * .---------------------------------------------. .---------------------------------------------.\n * | EQL | 1 | 2 | 3 | 4 | 5 | LEFT | ! RGHT | 6 | 7 | 8 | 9 | 0 | MINS |\n * !-------+-----+-----+-----+-----+-------------! !-------+-----+-----+-----+-----+-----+-------!\n * | DELT | Q | W | E | R | T |TG(SYMB| !TG(SYMB| Y | U | I | O | P | BSLS |\n * !-------+-----+-----+-----x-----x-----! ! ! !-----x-----x-----+-----+-----+-------!\n * | BSPC | A | S | D | F | G |-------! !-------! H | J | K | L |LT(MD|GUI_T(K|\n * !-------+-----+-----+-----x-----x-----!ALL_T(K! !MEH_T(K!-----x-----x-----+-----+-----+-------!\n * | LSFT |CTL_T| X | C | V | B | | ! | N | M |COMM | DOT |CTL_T| RSFT |\n * '-------+-----+-----+-----+-----+-------------' '-------------+-----+-----+-----+-----+-------'\n * |LT(SYM|QUOT |LALT(|LEFT |RGHT | ! UP |DOWN |LBRC |RBRC | FN1 |\n * '------------------------------' '------------------------------'\n * .---------------. .---------------.\n * |ALT_T(K| LGUI | ! LALT |CTL_T(K|\n * .-------+-------+-------! !-------+-------+-------.\n * ! SPC ! BSPC | HOME | ! PGUP | TAB ! ENT !\n * ! ! !-------! !-------! ! !\n * | | | END | ! PGDN | | |\n * '-----------------------' '-----------------------'\n */\n\n\n/*\n *\n * .---------------------------------------------. .---------------------------------------------.\n * | VRSN | F1 | F2 | F3 | F4 | F5 | | ! | F6 | F7 | F8 | F9 | F10 | F11 |\n * !-------+-----+-----+-----+-----+-------------! !-------+-----+-----+-----+-----+-----+-------!\n * | |EXLM | AT |LCBR |RCBR |PIPE | | ! | UP | 7 | 8 | 9 |ASTR | F12 |\n * !-------+-----+-----+-----x-----x-----! ! ! !-----x-----x-----+-----+-----+-------!\n * | |HASH | DLR |LPRN |RPRN | GRV |-------! !-------!DOWN | 4 | 5 | 6 |PLUS | |\n * !-------+-----+-----+-----x-----x-----! ! ! !-----x-----x-----+-----+-----+-------!\n * | |PERC |CIRC |LBRC |RBRC |TILD | | ! |AMPR | 1 | 2 | 3 |BSLS | |\n * '-------+-----+-----+-----+-----+-------------' '-------------+-----+-----+-----+-----+-------'\n * | EPRM | | | | | ! | DOT | 0 | EQL | |\n * '------------------------------' '------------------------------'\n * .---------------. .---------------.\n * |RGB_MOD| | !RGB_TOG|RGB_SLD|\n * .-------+-------+-------! !-------+-------+-------.\n * !RGB_VAD!RGB_VAI| | ! |RGB_HUD!RGB_HUI!\n * ! ! !-------! !-------! ! !\n * | | | | ! | | |\n * '-----------------------' '-----------------------'\n */\n\n\n/*\n *\n * .---------------------------------------------. .---------------------------------------------.\n * | | | | | | | | ! | | | | | | |\n * !-------+-----+-----+-----+-----+-------------! !-------+-----+-----+-----+-----+-----+-------!\n * | | | |MS_U | | | | ! | | | | | | |\n * !-------+-----+-----+-----x-----x-----! ! ! !-----x-----x-----+-----+-----+-------!\n * | | |MS_L |MS_D |MS_R | |-------! !-------! | | | | | MPLY |\n * !-------+-----+-----+-----x-----x-----! ! ! !-----x-----x-----+-----+-----+-------!\n * | | | | | | | | ! | | |MPRV |MNXT | | |\n * '-------+-----+-----+-----+-----+-------------' '-------------+-----+-----+-----+-----+-------'\n * | | | |BTN1 |BTN2 | !VOLU |VOLD |MUTE | | |\n * '------------------------------' '------------------------------'\n * .---------------. .---------------.\n * | | | ! | |\n * .-------+-------+-------! !-------+-------+-------.\n * ! ! | | ! | ! WBAK !\n * ! ! !-------! !-------! ! !\n * | | | | ! | | |\n * '-----------------------' '-----------------------'\n */\n```\n\nOutput json file.\nThis json file can be used in [http://www.keyboard-layout-editor.com/](http://www.keyboard-layout-editor.com/).\n\n\n```sh\n$ keymapviz qmk_firmware/keyboards/lets_split/keymaps/default/keymap.c -t json -o 'lets_split{}.json'\n$ ls lets_split*.json\nlets_split0.json lets_split1.json lets_split2.json lets_split3.json lets_split4.json lets_split5.json\n```\n\nReplace ascii-art in keymap.c. (Generate backup as keymap.c.bac)\n\n```sh\n$ keymapviz -r keymap.c\n```\n\n## License\n\nThis software is released under the MIT License, see LICENSE.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/yskoht/keymapviz", "keywords": "keymapviz keymap.c", "license": "", "maintainer": "", "maintainer_email": "", "name": "keymapviz", "package_url": "https://pypi.org/project/keymapviz/", "platform": "", "project_url": "https://pypi.org/project/keymapviz/", "project_urls": { "Bug Reports": "https://github.com/yskoht/keymapviz/issues", "Homepage": "https://github.com/yskoht/keymapviz", "Source": "https://github.com/yskoht/keymapviz" }, "release_url": "https://pypi.org/project/keymapviz/1.1.0/", "requires_dist": null, "requires_python": ">=3.5", "summary": "keymap.c visualizer", "version": "1.1.0" }, "last_serial": 5451498, "releases": { "1.1.0": [ { "comment_text": "", "digests": { "md5": "ccedf8283f1914edad12e7357255ef7f", "sha256": "7dd10ca62271f508ad2071df2712b82e038a1ed6e36268db6738580b4364f162" }, "downloads": -1, "filename": "keymapviz-1.1.0.tar.gz", "has_sig": false, "md5_digest": "ccedf8283f1914edad12e7357255ef7f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 10491, "upload_time": "2019-06-26T12:51:21", "url": "https://files.pythonhosted.org/packages/9a/c8/6dd000f3301442fdfdc53df01bb2acde1cf66366ed745cecc5ae3eac8eb7/keymapviz-1.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ccedf8283f1914edad12e7357255ef7f", "sha256": "7dd10ca62271f508ad2071df2712b82e038a1ed6e36268db6738580b4364f162" }, "downloads": -1, "filename": "keymapviz-1.1.0.tar.gz", "has_sig": false, "md5_digest": "ccedf8283f1914edad12e7357255ef7f", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 10491, "upload_time": "2019-06-26T12:51:21", "url": "https://files.pythonhosted.org/packages/9a/c8/6dd000f3301442fdfdc53df01bb2acde1cf66366ed745cecc5ae3eac8eb7/keymapviz-1.1.0.tar.gz" } ] }