Skip to main content

Reapy

This is a project to continue the legacy of https://github.com/RomeoDespres/reapy since 2025.

  • The goal is to keep Reapy living on and make the fun automation happened in the current Python and Reaper versions.
  • The original Reapy package hasn't been updated in a long time. I attempted to submit a bug fixes causing fx methods not working after reconnect long ago, but has not been handled. I assume the contributors have moved on.
  • It is a cool project, so let's keep it aflow. And instead of keeping it a fork, this will be on its own.
  • Unfortunately I have very little time to figure the documentations, helps appreciated!!!

Official Reascript documentation

https://www.reaper.fm/sdk/reascript/reascript.php

How to setup Reapy / Reascript

The guide is MacOS only currently, tested on Reaper v7.36

Part 1 Reaper Setup

Enable Reascript

  • Open Reaper Preferences (Settings), under Plug-ins -- Reascript, select Enable Python for use with ReaScript.
  • The next field is: Custom path to Python dll directory
    • On Apple Silicon with Python installed using homebrew, you can find the libpython$PYTHON_VERSION.dylib in /opt/homebrew/opt/python@$PYTHON_VERSION/Frameworks/Python.framework/Versions/$PYTHON_VERSION/lib, relace $PYTHON_VERSION with the version you intend to use, e.g. 3.12.
    • If you are unsure how to find it you can run: python3.12 -c "import sys; print(sys.prefix)" to get the folder before lib, the the dylib file in like in ./lib or ./lib/python3.12/config-3.12-darwin/
  • In the dylib file, type in the name of the dylib file, e.g libpython3.12.dylib
  • Restart Reaper

Part 2 Python package

  • pip install reapy
  • For local dev:
    • Under your virtual environment, navigate to the root folder of this project
    • pip install -e .
  • Run python -c "import reapy; reapy.configure_reaper()"
    • You may see this message:
    DisabledDistAPIWarning: Can't reach distant API. Please start REAPER, or call reapy.config.enable_dist_api() from inside REAPER to enable distant API.
    warnings.warn(errors.DisabledDistAPIWarning())
    
    • Don't worry just restart Reapy and Python that is it!
  • Test the installation with: python -c "import reapy; reapy.print('a message')"
  • Check Reaper there should be a console log message.

Optional: For uninterrupted automation

This part is not conpulsory for Reapy/Reascript to work, but it disabled certain features to make automation more repreducible.

Open Preferences on Reaper

- In `General`, uncheck automatic update version check in Startup Settings. (Better for CI automation)

- General --> Open project(s) on startup to -- New project (ignore default template)

- Project --> Project loading uncheck prompt when files are not found on project load (This can break automation)

- Audio --> Recording uncheck all options in Prompt to save/delete/rename new files

- Audio --> Rendering check Automatically close render window when render has finished

Quick guide:

Refer to examples folder.

Using ReaScript API directly

Not all API are implemented in reapy currently. You can find available API in: https://www.reaper.fm/sdk/reascript/reascripthelp.html

from reapy import reascript_api as RPR

print(RPR.GetProjectName())

Interact with UI with Perform Action

Action list can be found in: https://raw.githubusercontent.com/Ultraschall/ultraschall-lua-api-for-reaper/Ultraschall-API-4.6/ultraschall_api/misc/misc_docs/Reaper-ActionList.txt

Use Action ID:

You can find available action ID in:

https://raw.githubusercontent.com/Ultraschall/ultraschall-lua-api-for-reaper/Ultraschall-API-4.6/ultraschall_api/misc/misc_docs/Reaper-ActionList.txt

import reapy
project = reapy.Project()
track = project.tracks[0].select()
project.perform_action(40701)

Metadata

Release files for reapy-next 0.10.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for reapy-next 0.10.1
File Size Uploaded Provenance Actions
reapy_next-0.10.1.tar.gz 81.9 kB Without provenance Details for reapy_next-0.10.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for reapy-next 0.10.1
File Interpreter ABI Platform Actions
reapy_next-0.10.1-py3-none-any.whl Python 3 none any Details for reapy_next-0.10.1-py3-none-any.whl

Total release size: 215.0 kB

Release files / reapy_next-0.10.1.tar.gz

Download URL reapy_next-0.10.1.tar.gz
Size 81.9 kB
Tags Source
SHA-256 checksum
How to use checksums
4991ad1da41e12afc5bce66e708abaa932cbc0ae432c3e15069c348ade995890
BLAKE2b-256 checksum
How to use checksums
06a920df45759b64c9ed294a46c96d42758a1a44eaf2419e70bc39ddd21ccb87
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.8

Release files / reapy_next-0.10.1-py3-none-any.whl

Download URL reapy_next-0.10.1-py3-none-any.whl
Size 133.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1ae9b44ddf944a0fb3c0d463b3ed7fc8fc78f500c5b9db1679d4f104a5d9f315
BLAKE2b-256 checksum
How to use checksums
d79587b551c924f8931604b4ce80bf8d8cf0bb3ee78ab9a5289ac36a33bade4e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.8

Security for reapy-next 0.10.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.10.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page