Skip to main content

PEP 561 type stubs for Ableton Live's Python API (for MIDI Remote Script developers)

Project description

ableton-live-stubs

PEP 561 type stubs for Ableton Live 11.3.43's Python API (Live.* modules).

These stubs are for developers building MIDI Remote Scripts (Control Surfaces) that run inside Ableton Live's embedded Python runtime. They provide type information for the Live module that Live exposes to scripts at runtime but is not available for static analysis outside of Live.

Installation

pip install ableton-live-stubs

Usage

Once installed, type checkers (pyright, mypy) automatically discover the Live module stubs. No configuration needed.

Import types under TYPE_CHECKING to avoid runtime import errors (the Live module only exists inside Ableton Live's Python runtime):

from __future__ import annotations
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    import Live
    from Live.Song import Song

def on_tempo_changed(song: Song) -> None:
    app: Live.Application.Application = Live.Application.get_application()
    print(f"Live {app.get_major_version()}: tempo is now {song.tempo}")

Manual setup (without pip)

Download the zip from the GitHub release and add the extracted directory (the parent of Live/) to your type checker's stub path:

// pyrightconfig.json
{
  "stubPath": "path/to/Live-stubs"
}

Version matching

Each release of ableton-live-stubs corresponds to a specific Ableton Live version. Install the version that matches your target Live version — the API surface changes between releases.

Documentation

For detailed API documentation — including property restrictions (e.g. which track/clip types support a given property), valid input ranges, and observable properties — see the LiveAPI reference.

Source

Generated from runtime introspection of Ableton Live 11.3.43. See LiveAPI for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ableton_live_stubs-11.3.43.post2.tar.gz (46.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ableton_live_stubs-11.3.43.post2-py3-none-any.whl (68.5 kB view details)

Uploaded Python 3

File details

Details for the file ableton_live_stubs-11.3.43.post2.tar.gz.

File metadata

File hashes

Hashes for ableton_live_stubs-11.3.43.post2.tar.gz
Algorithm Hash digest
SHA256 194c7de559eb4249e04a943e6fb006b07353f4ee3c4e3a5ccbf9679a5e7941de
MD5 0c634989ac57715d92655dc6e1e0b2c2
BLAKE2b-256 c9be38f37be3aa863f00031ee9156bec2176b6d329b88f37d3d4e7301cf7cad2

See more details on using hashes here.

Provenance

The following attestation bundles were made for ableton_live_stubs-11.3.43.post2.tar.gz:

Publisher: release.yml on PhotonicVelocity/LiveAPI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ableton_live_stubs-11.3.43.post2-py3-none-any.whl.

File metadata

File hashes

Hashes for ableton_live_stubs-11.3.43.post2-py3-none-any.whl
Algorithm Hash digest
SHA256 a25b2ae9203a73e19e89927022c34548912957f972c08e1236beab482aaf1252
MD5 ebd9c68c40e36210f8ce0cd5db468c90
BLAKE2b-256 092f6c1e33a1aa0eb484f392c3867e18681c811391d18b292a40cc66800f27f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for ableton_live_stubs-11.3.43.post2-py3-none-any.whl:

Publisher: release.yml on PhotonicVelocity/LiveAPI

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page