Skip to content

Fix setup instructions and missing dependencies #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonrichards wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix setup instructions and missing dependencies #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f796dd
Add Python 3.11 requirement with uv and pyenv setup instructions
jonrichards Dec 12, 2025
8965ab7
Add missing python-rtmidi dependency
jonrichards Dec 12, 2025
4c2aca5
Add missing author, band, and song fields to preset template
jonrichards Dec 12, 2025
82a2a30
Fix incorrect import statement in README examples
jonrichards Dec 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 24 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -76,15 +95,15 @@ Optionally change any default [settings](https://hacklabsguitar.github.io/helix-
Create an API instance.

```python
import helixapi
from helixapi.helix import Helix

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")
```
Expand Down
5 changes: 4 additions & 1 deletion helixapi/templates/preset.hlx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" : {
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
PyYAML
colorlog
mido
python-rtmidi