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
| Feature | Mouse | Keyboard | Gamepad |
|---|---|---|---|
| Toggle play/pause | — | Space | L 🕹️ ⊙ |
| Scrub playback | — | ↔ | L 🕹️ ↔ |
| Scrub playback faster | — | Shift+↔ | L 🕹️ ↔ + A |
| Zoom in/out | Ctrl+🖱️ scroll | Z / Shift+Z | R 🕹️ ↕ |
| Loop on selection or selected region | — | L | B |
| Toggle beep sound on region in/out | — | B | — |
| Toggle gap visualization | — | G | — |
| Toggle action HUD | — | H | — |
Selection
| Feature | Mouse | Keyboard | Gamepad |
|---|---|---|---|
| Toggle selection | 🖱️L + drag | S | R 🕹️ ⊙ |
| Edit selection start | — | ← / → | L 🕹️ ↔ |
| Edit selection end | — | Shift+← / Shift+→ | R 🕹️ ↔ |
| Remove the selection | — | Escape | A |
Regions
| Feature | Mouse | Keyboard | Gamepad |
|---|---|---|---|
| Create a region | 🖱️L×2 | Enter | X |
| Split region | — | Shift+Enter | R₂ |
| Delete selected region | — | Delete or Shift+Backspace | Y |
| Select region | 🖱️L on region | — | L₂ |
| Select previous/next region | — | Tab / Shift+Tab | L₁/R₁ |
| Edit selected region start | — | ↔ | L 🕹️ ↔ |
| Edit selected region end | — | Shift+↔ | R 🕹️ ↔ |
| Unselect region | — | Escape | A |
Labels
| Feature | Mouse | Keyboard | Gamepad |
|---|---|---|---|
| Cycle next/previous label for selected region | — | > / < | ✜ ↕ |
1 maintainer
Metadata
1 maintainer
Release files for ipyannote 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ipyannote-0.7.0.tar.gz | 86.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ipyannote-0.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 186.3 kB
Release files / ipyannote-0.7.0.tar.gz
| Download URL | ipyannote-0.7.0.tar.gz |
|---|---|
| Size | 86.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
52b18a09aedd459373151a706146ced3cc0b4be6fe71cb39e5035711724e7ad9
|
|
BLAKE2b-256 checksum How to use checksums |
6447df4e92af0cf957c14b53b839ebfc16e3135a8904d26e9a21ab142ed9a574
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / ipyannote-0.7.0-py3-none-any.whl
| Download URL | ipyannote-0.7.0-py3-none-any.whl |
|---|---|
| Size | 100.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
17bb4b9b7d50d6117fc2360d1912a6eddc90c0ddbd17d05245b29d126a936075
|
|
BLAKE2b-256 checksum How to use checksums |
55e262bbf8761015b2f5f64bf5f91ac927d976067e2079fce62c9b5f757ebdb9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.1 {"installer":{"name":"uv","version":"0.12.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
