Merge pull request #38 from FrameworkComputer/python-docs

python: Add development instructions and fix running locally

python/README.md

@@ -12,3 +12,34 @@ python3 -m pip install qmk_hid
 
 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()
+```

python/pyproject.toml

@@ -29,9 +29,9 @@ classifiers = [
 Issues = "https://github.com/FrameworkComputer/qmk_hid/issues"
 Source = "https://github.com/FrameworkComputer/qmk_hid"
 
-# TODO: Figure out how to add a runnable-script
-#[project.scripts]
-#qmk_hid = "qmk_hid.gui:main_cli"
+# TODO: There's no CLI yet
+# [project.scripts]
+# qmk_hid = "qmk_hid.gui:main_cli"
 
 [project.gui-scripts]
 qmk_gui = "qmk_hid.gui:main"
@@ -66,4 +66,4 @@ exclude = [
 # pretty = true
 # show_column_numbers = true
 # warn_no_return = false
-# warn_unused_ignores = true
+# warn_unused_ignores = true

python/qmk_hid/gui.py

@@ -11,7 +11,7 @@
     from win32con import VK_NUMLOCK, VK_CAPITAL
     import winreg
 
-import uf2conv
+import qmk_hid.uf2conv
 
 # TODO:
 # - Get current values

python/qmk_hid/uf2conv.py

@@ -238,7 +238,7 @@ def get_drives():
                                      "get", "DeviceID,",
                                      "FileSystem,", "DriveType"])
         for line in to_str(r).split('\n'):
-            words = re.split('\s+', line)
+            words = re.split(r'\s+', line)
             if len(words) >= 3 and words[1] == "2" and words[2] == "FAT":
                 drives.append(words[0])
     else: