Metadata-Version: 2.4
Name: qmk_hid
Version: 0.1.12
Summary: A GUI tool to control QMK keyboard, specifically of the Framework Laptop 16
Project-URL: Issues, https://github.com/FrameworkComputer/qmk_hid/issues
Project-URL: Source, https://github.com/FrameworkComputer/qmk_hid
Author-email: Daniel Schaefer <dhs@frame.work>
License: MIT
Keywords: hatch
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: hidapi==0.14.0.post2
Requires-Dist: pywin32; os_name == 'nt'
Description-Content-Type: text/markdown

# Python

## Installing

Pre-requisites: Python with pip

```sh
python3 -m pip install qmk_hid
```

## GUI

On Linux install Python requirements via `python3 -m pip install -r requirements.txt` and run `python3 qmk_hid/gui.py`.
On Windows download the `qmk_gui.exe` and run it.

## Developing

One time setup

```
# Install dependencies on Ubuntu
sudo apt install python3 python3-tk python3-devel libhidapi-dev
# Install dependencies on Fedora
sudo dnf install python3 python3-tkinter hidapi-devel
# Create local venv and enter it
python3 -m venv venv
source venv/bin/activate
# Install package into local env
python3 -m pip install -e .
```

Developing

```
# In every new shell, source the virtual environment
source venv/bin/activate
# Launch GUI or commandline
qmk_gui

# Launch Python REPL and import the library
# As example, launch the GUI
> python3
>>> from qmk_hid import gui
>>> gui.main()
```
