chore: Switch tooling to uv, ruff, prek

Switched from Pip to uv for package management, Black, isort, and Pylint
to Ruff for linting and formatting, and pre-commit to prek for commit
hooks. These are faster and/or easier to work with.

Added an initial set of Ruff checks and updated the codebase to address
issues detected by them.

The minimum Python version of 3.10 was originally set based on what is
provided with Ubuntu 22.04 LTS. Now that we're instructing users to
install ZMK CLI with uv though, we're no longer dependent on the system
Python version. Updated to 3.11 to remove the need for the StrEnum
backport.

Author: joelspadin

.github/workflows/ci.yml

@@ -8,21 +8,23 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v6
+
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v7
         with:
-          python-version: ">=3.10"
-          cache: "pip"
+          enable-cache: true
+
       - name: Install dependencies
-        run: |
-          pip install .
-          pip install pylint
+        run: uv sync --locked --all-extras --dev
 
-      - name: pre-commit
-        uses: pre-commit/[email protected]
+      - name: prek
+        uses: j178/prek-action@v1
 
       - name: pyright
         uses: jakebailey/pyright-action@v2
-
-      - name: pylint
-        run: pylint zmk

.pre-commit-config.yaml

@@ -1,20 +1,12 @@
 fail_fast: false
 repos:
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.21.2
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.2
     hooks:
-      - id: pyupgrade
-        args: [--py310-plus]
-  - repo: https://github.com/pycqa/isort
-    rev: "7.0.0"
-    hooks:
-      - id: isort
-  - repo: https://github.com/psf/black
-    rev: "25.12.0"
-    hooks:
-      - id: black
+      - id: ruff-check
+      - id: ruff-format
   - repo: https://github.com/Lucas-C/pre-commit-hooks
-    rev: v1.5.5
+    rev: v1.5.6
     hooks:
       - id: remove-tabs
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -26,7 +18,7 @@ repos:
       - id: check-added-large-files
       - id: check-shebang-scripts-are-executable
   - repo: https://github.com/tombi-toml/tombi-pre-commit
-    rev: v0.7.14
+    rev: v0.7.32
     hooks:
       - id: tombi-format
       - id: tombi-lint

.vscode/extensions.json

@@ -1,7 +1,3 @@
 {
-  "recommendations": [
-    "ms-python.black-formatter",
-    "ms-python.isort",
-    "ms-python.python"
-  ]
+  "recommendations": ["charliermarsh.ruff", "ms-python.python"]
 }

.vscode/settings.json

@@ -1,9 +1,9 @@
 {
   "editor.formatOnSave": true,
   "[python]": {
-    "editor.defaultFormatter": "ms-python.black-formatter",
+    "editor.defaultFormatter": "charliermarsh.ruff",
     "editor.codeActionsOnSave": {
-      "source.organizeImports": "always"
+      "source.organizeImports": "explicit"
     }
   },
   "[markdown][yaml]": {
@@ -20,8 +20,8 @@
     "**/templates/shield/**": "mako",
     "**/templates/common/**": "mako"
   },
-  "isort.check": true,
-  "isort.args": ["--settings-path", "${workspaceFolder}"],
+  "pylint.enabled": false,
+  "ruff.enabled": true,
   "python.analysis.importFormat": "relative",
   "python.analysis.typeCheckingMode": "standard",
   "python-envs.pythonProjects": []

README.md

@@ -8,100 +8,30 @@ The instructions below contain commands that need to be run in a terminal progra
 
 # Installation
 
-## Install Git
-
-Install Git from https://git-scm.com/downloads.
-
-If you have Windows 11, you can instead open a terminal and run:
-
-```sh
-winget install git.git -i
-```
-
-The Windows installer will give you lots of options. You can leave all of them as their defaults, but when you get to the "choosing the default editor used by Git" screen, you may want to select a different text editor to use when writing Git commit messages.
-
-## Install Python
-
-ZMK CLI requires Python 3.10 or newer.
-
-### On Windows and macOS
-
-Install the latest version of Python from https://www.python.org/downloads/.
-
-If you have Windows 11, you can instead open a terminal and run:
-
-```sh
-winget install python3
-```
-
-### On Linux
-
-Most Linux distributions come with Python already installed. Open a terminal and run the following command to check its version:
-
-```sh
-python3 --version
-```
-
-If Python is not installed, install `python3` with your package manager.
-
-If the version is older than 3.10, you will need to find and install a package for a newer version of Python. On Ubuntu 20.04 and older, you can get Python 3.10 from the deadsnakes PPA with the following commands:
-
-```sh
-sudo add-apt-repository ppa:deadsnakes/ppa
-sudo apt install python3.10
-```
-
-You will then need to replace `python3` with `python3.10` in the rest of the installation instructions.
+This readme will provide brief instructions for installing ZMK CLI. For instructions in more detail, see the [ZMK Documentation](https://zmk.dev/docs/user-setup).
 
-## Install pipx
-
-ZMK CLI can be installed with pip, but using [pipx](https://github.com/pypa/pipx) is recommended to avoid conflicts between Python packages.
-
-### On Windows and Linux
-
-Open a terminal and run:
-
-```sh
-python3 -m pip install --user pipx
-python3 -m pipx ensurepath
-```
-
-Some Linux distributions may disallow installing packages with pip. If this gives you an error, see the [install instructions](https://github.com/pypa/pipx?tab=readme-ov-file#on-linux) specific to your distribution.
-
-Close and reopen your terminal, then run the following command. It should print a version number if everything is installed correctly:
+## Install Git
 
-```sh
-pipx --version
-```
+Install Git from https://git-scm.com/downloads or your OS's package manager.
 
-### On macOS
+You will also need a [GitHub account](https://github.com/signup).
 
-Open Terminal and run:
+## Install uv
 
-```
-brew install pipx
-pipx ensurepath
-```
+Install uv from https://docs.astral.sh/uv/getting-started/installation/
 
 ## Install ZMK CLI
 
-Next, run the following commands:
+Run the following
 
 ```sh
-pipx install zmk
-zmk --help
+uv tool install zmk
 ```
 
-It should print a help message if everything installed correctly.
-
-On Linux, you may get an error saying you need to install another package such as `python3.10-venv`. If so, follow the instructions in the error message, then try the above commands again.
-
-## Update ZMK CLI
-
 If you have already installed ZMK CLI, you can update to the latest version with the following command:
 
 ```sh
-pipx upgrade zmk
+uv tool upgrade zmk
 ```
 
 # Usage
@@ -272,22 +202,45 @@ zmk config user.home ~/Documents/zmk-config
 
 # Development
 
-If you would like to help improve ZMK CLI, you can clone this repo and install it in editable mode so your changes to the code apply when you run `zmk`. First, open a terminal to the root directory of the repository.
+If you would like to help improve ZMK CLI, you can clone this repo and install it into a virtual environment where you can modify it. First, open a terminal to the root directory of the repository. Then, create a virtual environment and install the project's dependencies:
+
+```sh
+# Create the virtual environment
+uv venv .venv
+# This will print a message like "Activate with: source .venv/Scripts/activate"
+# If it prints a command that's different than the one shown here, run that instead.
+source .venv/Scripts/activate
+# Install dependencies
+uv sync
+# Install pre-commit hooks
+prek install
+```
+
+Running `zmk` while inside the virtual environment will run the development version of the program, so you can make and test changes to the code.
+
+Note that you will need to run the "activate" command again every time you open a new terminal (some IDEs such as VS Code will automate this for you). Alternatively, you can use `uv run zmk` to run the program instead of just `zmk`, which will automatically enter the virtual environment, run `zmk`, and then exit it.
+
+If you want `zmk` to run the development version even when you are not inside the virtual environment, you can install it globablly in editable mode:
+
+```sh
+uv tool install -e .
+```
 
-You may optionally run the following commands inside a [virtual environment](https://docs.python.org/3/library/venv.html) if you don't want to install ZMK CLI's dependencies globally or if your OS disallows doing this.
+## Linting
 
-To install ZMK CLI in editable mode, run:
+After running `prek install`, linting and code formatting will be run automatically when you make a commit. You can also run these tools manually:
 
 ```sh
-pip install -e ".[dev]"
-pre-commit install
+# lint codebase
+ruff check
+# format files
+ruff format
 ```
 
-After running `pre-commit install`, your code will be checked when you make a commit, but there are some slower checks that do not run automatically. To run these additional checks, run these commands:
+Type checking is slower and difficult to configure to run as a Git commit hook, so this needs to be run manually.
 
 ```sh
 pyright .
-pylint zmk
 ```
 
 GitHub will also run these checks and report any errors when you make a pull request.

pyproject.toml

@@ -2,8 +2,8 @@
 name = "zmk"
 description = "A command line program to help set up ZMK Firmware"
 readme = "README.md"
-requires-python = ">=3.10"
-license = { file = "LICENSE" }
+requires-python = ">=3.11"
+license-files = ["LICENSE"]
 classifiers = [
   "Development Status :: 3 - Alpha",
   "Environment :: Console",
@@ -15,11 +15,10 @@ classifiers = [
   "Topic :: Utilities",
 ]
 dependencies = [
-  "backports.strenum; python_version < '3.11'",
   "dacite >= 1.9.2, < 2.0.0",
   "giturlparse >= 0.14.0, < 0.15.0",
   "mako >= 1.3.10, < 2.0.0",
-  "rich >= 14.2.0, < 15.0.0",
+  "rich >= 14.3.3, < 15.0.0",
   "ruamel.yaml >= 0.18.17, < 0.19.0",
   "shellingham >= 1.5.4, < 2.0.0",
   "typer >= 0.21.0, < 0.22.0",
@@ -36,30 +35,62 @@ Documentation = "https://zmk.dev/docs"
 [project.scripts]
 zmk = "zmk.main:app"
 
-[project.optional-dependencies]
-dev = ["pre-commit", "pylint", "pyright"]
+[dependency-groups]
+dev = [
+  "prek>=0.3.3",
+  "pyright>=1.1.408",
+  "ruff>=0.15.2",
+]
 
 [build-system]
 requires = ["setuptools", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
-[tool.isort]
-profile = "black"
-
-[tool.pylint.MAIN]
-ignore = "_version.py"
-
-[tool.pylint."MESSAGES CONTROL"]
-disable = [
-  "arguments-differ",  # Covered by pyright
-  "fixme",
-  "too-few-public-methods",
-  "too-many-arguments",
-  "too-many-branches",
-  "too-many-instance-attributes",
-  "too-many-locals",
-  "too-many-positional-arguments",
-  "too-many-statements",
+[tool.ruff.lint]
+select = [
+  # flake8-builtins
+  "A",
+  # flake8-bugbear
+  "B",
+  # flake8-blind-except
+  "BLE",
+  # flake8-comprehensions
+  "C4",
+  # pycodestyle
+  "E4",
+  "E7",
+  "E9",
+  # pyflakes
+  "F",
+  # flake8-boolean-trap
+  "FBT",
+  # refurb
+  "FURB",
+  # flake8-implicit-str-concat
+  "ISC",
+  # pep8-naming
+  "N",
+  # perflint
+  "PERF1",
+  "PERF4",
+  # flake8-pie
+  "PIE",
+  # flake8-use-pathlib
+  "PTH",
+  # flake8-return
+  "RET",
+  # ruff
+  "RUF",
+  # flake8-bandit
+  # "S", TODO: enable this and fix issues in a separate commit
+  # flake8-simplify
+  "SIM",
+  # flake8-self
+  "SLF",
+  # flake8-type-checking
+  "TC",
+  # pyupgrade
+  "UP"
 ]
 
 [tool.setuptools]