ipyannote

Installation

pip install ipyannote

or with uv:

uv add ipyannote

Development

We recommend using uv for development. It will automatically manage virtual environments and dependencies for you.

uv run jupyter lab example.ipynb

Alternatively, create and manage your own virtual environment:

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab example.ipynb

The widget front-end code bundles it's JavaScript dependencies. After setting up Python, make sure to install these dependencies locally:

npm install

While developing, you can run the following in a separate terminal to automatically rebuild JavaScript as you make changes:

npm run dev

Open example.ipynb in JupyterLab, VS Code, or your favorite editor to start developing. Changes made in js/ will be reflected in the notebook.

Keyboard and gamepad shortcuts

The Waveform widget supports both keyboard shortcuts and standard gamepads. Click the waveform to give it focus before using either.

Gamepad bindings follow the W3C standard gamepad layout, which maps actions to button positions. Physical labels, however, differ by manufacturer: this table uses Xbox-style labels (A/B/X/Y). If you use a Nintendo-style controller, A and B (as well as X and Y) are physically swapped. The gamepad notation below uses 🕹️ for an analog stick, ⊙ for a stick click, ↔ for left/right axis, ↕ for up/down axis, and ✜ for the D-pad.

Playback

Selection

Regions

Labels