A pythonic wrapper for REAPER's ReaScript Python API
Project description
reapy
reapy
is a nice pythonic wrapper around the quite unpythonic ReaScript Python API for REAPER.
Getting Started
Installing
- First install from
pip
:
pip install python-reapy
- Run:
python -m reapy
Paths to your Python DLL and to reapy
configuration scripts get printed.
-
If you haven't enabled Python in REAPER yet, go to Options > Preferences... > Plug-ins > ReaScript. Check Enable Python for use with ReaScript, and fill Custom path to Python dll directory and Force ReaScript to use specific Python .dll with the directory path and the file name of the Python DLL.
-
Enable
reapy
dist API by running the corresponding ReaScript (Actions > Show action list > Reascript : Load... and browse for the script path).
You're all set! You can now import reapy
from inside or outside REAPER as any standard Python module.
Instead of creating a new ReaScript containing:
from reaper_python import *
RPR_ShowConsoleMsg("Hello world!")
you can open your usual Python shell and type:
>>> import reapy
>>> reapy.print("Hello world!")
Usage
ReaScript API
All ReaScript API functions are available in reapy
in the sub-module reapy.reascript_api
. Note that in ReaScript Python API, all function names start with "RPR_"
. That unnecessary pseudo-namespace has been removed in reapy
. Thus, you shall call reapy.reascript_api.GetCursorPosition
in order to trigger reaper_python.RPR_GetCursorPosition
. See example below.
>>> from reapy import reascript_api as RPR
>>> RPR.GetCursorPosition()
0.0
>>> RPR.SetEditCurPos(1, True, True)
>>> RPR.GetCursorPosition()
1.0
reapy
API
The purpose of reapy
is to provide a more pythonic API as a substitute for ReaScript API. Below is the reapy
way of executing the example above.
>>> import reapy
>>> project = reapy.Project() # Current project
>>> project.cursor_position
0.0
>>> project.cursor_position = 1
>>> project.cursor_position
1.0
The translation table matches ReaScript functions with their reapy
counterparts.
Performance
When used from inside REAPER, reapy
has almost identical performance than native ReaScript API. Yet when it is used from the outside, the performance is quite worse. More precisely, since external API calls are processed in a defer
loop inside REAPER, there can only be around 30 to 60 of them per second.
In a time-critical context, you can make use of the reapy.tools.Program
feature. It allows to execute arbitrary code inside REAPER, with input and output sent over the local network.
In the example below, one can see how to make use of Program
to improve efficiency. Input parameters are passed to the program as Program.run
keyword arguments. Required output values are specified as Program
positional arguments after code
(first positional argument).
Note that the modules reapy
and reascript_api
(as RPR
) are always available in Program
s. Any other needed module must be explicitly imported in the code
.
>>> import reapy
>>> project = reapy.Project() # Current project
>>> # Unefficient (and useless) call
>>> start = time.time(); bpms = [project.bpm for _ in range(100)] # Takes at least 3 seconds!
>>> # Efficient call
>>> from reapy.tools import Program
>>> code = """
... project = reapy.Project(project_id)
... bpms = [project.bpm for _ in range(100)]
... """
>>> [bpms] = Program(code, "bpms").run(project_id = project.id) # Takes 1/30 seconds (= one distant call)
More
Check the documentation for more information.
Author
Roméo Després - RomeoDespres
License
This project is licensed under the MIT License - see the LICENSE.txt file for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for python_reapy-0.1.0.dev2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e085108285bb7c2fe69b764e48cae69035a8745cbb4a430814c1032da3f0b2f0 |
|
MD5 | 73f0b5594cf8ba5dddfa6ad397974dfb |
|
BLAKE2b-256 | 748bf6486f99fad5653ede861576caef4b001896c71803dfd60f112879af9d65 |