From 855b234813fc930a216da9aae301a3c251ebf10e Mon Sep 17 00:00:00 2001
From: Nick Brassel <nick@tzarc.org>
Date: Sun, 1 Dec 2024 15:41:45 +1100
Subject: [PATCH] venv helper

---
 util/venv.sh | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100755 util/venv.sh

diff --git a/util/venv.sh b/util/venv.sh
new file mode 100755
index 00000000000..dda36b64a2d
--- /dev/null
+++ b/util/venv.sh
@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+# This script is used to setup a virtual environment for QMK use, and subsequently allows running `qmk` commands from the virtual environment.
+
+# Exit on error
+set -eEuo pipefail
+umask 022
+
+# Find the QMK firmware directory
+this_script=$(realpath "${BASH_SOURCE[0]}")
+this_dir=$(dirname "$this_script")
+qmk_firmware_dir=$(realpath "$this_dir/..")
+
+# Allow overriding the virtual environment directory from the environment, if necessary
+if [ -z "${QMK_VENV_DIR:-}" ]; then
+    QMK_VENV_DIR="$qmk_firmware_dir/.venv"
+fi
+
+# Switch to the QMK firmware directory
+cd "$qmk_firmware_dir"
+
+# Check if the virtual environment exists
+if [ ! -d "$QMK_VENV_DIR" ]; then
+    echo "Creating virtual environment..."
+    python3 -m venv "$QMK_VENV_DIR"
+fi
+
+# Activate the virtual environment
+source "$QMK_VENV_DIR/bin/activate"
+
+# Install qmk into the venv if it's not already installed
+if [[ ! -e "$QMK_VENV_DIR/bin/qmk" ]]; then
+    echo "Installing QMK CLI..."
+    pip install --require-virtualenv --quiet --no-input --upgrade pip qmk
+    pip install --require-virtualenv --quiet --no-input --upgrade -r requirements-dev.txt
+fi
+
+# Run the arguments as if it were a `qmk` command
+exec "$@"