From 3f796dd0d261048ff67a594a9c2239213a392b65 Mon Sep 17 00:00:00 2001 From: Jon Richards Date: Thu, 11 Dec 2025 20:31:44 -0800 Subject: [PATCH 1/4] Add Python 3.11 requirement with uv and pyenv setup instructions --- README.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 350cd55..9f3c88d 100644 --- a/README.md +++ b/README.md @@ -63,11 +63,30 @@ Your contributions are greatly appreciated! ## Getting Started -Download and install the API +This project requires Python 3.11. Choose one of the setup methods below: + +### Option A: Using uv (Recommended) + +[uv](https://docs.astral.sh/uv/) is a fast Python package and project manager. + +```bash +git clone https://github.com/HackLabsGuitar/helix-py-api.git +cd helix-py-api +uv venv +source .venv/bin/activate +uv pip install -r requirements.txt +``` + +### Option B: Using pyenv + +[pyenv](https://github.com/pyenv/pyenv) lets you easily switch between multiple versions of Python. ```bash -git clone https://github.com/HackLabsGuitar/`Helix-py-api`.git -cd `Helix-py-api` +git clone https://github.com/HackLabsGuitar/helix-py-api.git +cd helix-py-api +pyenv install +python -m venv venv +source venv/bin/activate pip install -r requirements.txt ``` From 8965ab7692681b2c06001ff3711eafda31ebdd23 Mon Sep 17 00:00:00 2001 From: Jon Richards Date: Thu, 11 Dec 2025 20:32:13 -0800 Subject: [PATCH 2/4] Add missing python-rtmidi dependency --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index f9e97f1..cd5a576 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ PyYAML colorlog mido +python-rtmidi From 4c2aca5635259c1831fd412859c0a47fd486db7e Mon Sep 17 00:00:00 2001 From: Jon Richards Date: Thu, 11 Dec 2025 20:32:36 -0800 Subject: [PATCH 3/4] Add missing author, band, and song fields to preset template --- helixapi/templates/preset.hlx | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/helixapi/templates/preset.hlx b/helixapi/templates/preset.hlx index 53d0d5b..8580b49 100644 --- a/helixapi/templates/preset.hlx +++ b/helixapi/templates/preset.hlx @@ -5,9 +5,12 @@ "meta" : { "application" : "HX Edit", "appversion" : 57671680, + "author" : "", + "band" : "", "build_sha" : "39f7f9a", "modifieddate" : 1715640960, - "name" : "New Preset" + "name" : "New Preset", + "song" : "" }, "tone" : { "dsp0" : { From 82a2a30cbb5f3d1698f53ec68e7362d4d92b1f87 Mon Sep 17 00:00:00 2001 From: Jon Richards Date: Thu, 11 Dec 2025 20:39:07 -0800 Subject: [PATCH 4/4] Fix incorrect import statement in README examples --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9f3c88d..1eaee4c 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ Optionally change any default [settings](https://hacklabsguitar.github.io/helix- Create an API instance. ```python -import helixapi +from helixapi.helix import Helix helix = Helix() ``` @@ -103,7 +103,7 @@ helix = Helix() This will load a default empty bundle template. You can instead load your own bundle: ```python -import helixapi +from helixapi.helix import Helix helix = Helix(file_path="/path/to/bundle.hlb") ```