GitHub last commit

py-ptsl

Native Python PTSL (Pro Tools Scripting Library) RPC interface

Important Notice!

This software is developed by enthusiasts and is not a work of or supported by Avid. Developers who wish to contribute to this project should obtain the PTSL SDK from Avid's Developer site for the most current documentation and protobuf source files.

Example

See the examples directory for scripts demonstrating how to use the client.

session_info.py - This example prints a list of gettable properties from the currently-open session.
print_tracks.py - This example prints a list of every track in the currently-open session, including state information like selection, mute and solo state, track color and track ID.
make_session.py - Creates a new session interactively from the terminal.
pt_set.py - Allows several session setup options to be set from the terminal.
pt_pasteboard.py - Demonstrates triggering cut/copy/paste actions.
toolshell.py - Implements a command line interface for Pro Tools.

Sending Commands To Pro Tools with the `Engine` class

The Engine class exposes ptsl commands with a method call interface.

from ptsl import open_engine

with open_engine(company_name="MY_COMPANY", application_name="MY_TOOL") as engine:
    session_name = engine.session_name()

Sending Commands to Pro Tools from the Command Line

The module implements a main function that can be called from the shell. Pass request JSON to the standard input and any response will be passed to standard output.

bash-3.2$ poetry run python3 -m ptsl GetTrackList <<JSON 
{"pagination_request": {
  "limit": 100, "offset": 0
  },
"track_filter_list": [
  {"filter": 0, "is_inverted": false}
  ]
}
JSON
{'pagination_response': {'total': 4, 'offset': 0, 'limit': 100}, 'track_list':
[{'name': 'Au dio 1', 'type': 'TT_Audio', 'format': 'TF_Mono', ...

bash-3.2$ poetry run python3 -m ptsl -n GetPTSLVersion
{"version": 2025}

Download files

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

Source Distribution

py_ptsl-602.0.0.tar.gz (92.7 kB view details)

Uploaded Jul 25, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

py_ptsl-602.0.0-py3-none-any.whl (121.8 kB view details)

Uploaded Jul 25, 2026 Python 3

File details

Details for the file py_ptsl-602.0.0.tar.gz.

File metadata

Download URL: py_ptsl-602.0.0.tar.gz
Upload date: Jul 25, 2026
Size: 92.7 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for py_ptsl-602.0.0.tar.gz
Algorithm	Hash digest
SHA256	`3bf0e35bc36711274e7a323a2efe8cf61948c5ed45b6135850022334e80743de`
MD5	`e16b976da3ec088d0145ba76bf2e08f0`
BLAKE2b-256	`1ba4c318420de64ea706ea7daf5f5dd58ee9567159deebb29a4a28da2031b1bc`

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_ptsl-602.0.0.tar.gz:

Publisher: python-publish.yaml on iluvcapra/py-ptsl

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: py_ptsl-602.0.0.tar.gz
- Subject digest: 3bf0e35bc36711274e7a323a2efe8cf61948c5ed45b6135850022334e80743de
- Sigstore transparency entry: 2254359576
- Sigstore integration time: Jul 25, 2026
Source repository:
- Permalink: iluvcapra/py-ptsl@23113d8e7bd859f9158418030a0ac2906ef342d2
- Branch / Tag: refs/tags/v602.0.0
- Owner: https://github.com/iluvcapra
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: python-publish.yaml@23113d8e7bd859f9158418030a0ac2906ef342d2
- Trigger Event: release