Getting Started
Install or build a Python processor enabled release
In order to use the Rotel Python processor SDK you need a python processor enabled rotel build. Processor enabled rotel builds link to specific versions of libpython at build time. There are a couple of ways to get a processor enabled build.
- Use a prebuilt Docker image. You can find prebuilt docker images of Rotel releases with built-in Python Processor support and Python 3.13 on Dockerhub with the following tags:
streamfold/rotel-python-processors:<release name>streamfold/rotel-python-processors:lateststreamfold/rotel-python-processors:sha-<sha>
When running an image, you can mount directories from your local filesystem as volumes to provide processor code
to the container with -v flag, for example: -v ~/my_processor_directory:/processors. You can then start rotel and
pass in processors like the example below.
docker run -ti -p 4317-4318:4317-4318 -v ~/my_processor_director:/processors streamfold/rotel-python-processors:latest
--exporter blackhole --debug-log traces --debug-log-verbosity detailed --otlp-with-trace-processor /processors/my_processor.py`
- Download a prebuilt Rotel python processor enabled binary. You can find prebuilt python processor enabled binaries for rotel at Github on the releases page. Python processor versions of Rotel are prefixed with the string
rotel_py_processor. Choose a release that matches your system architecture and the version of Python you have installed.
For example if you are running rotel on linux x86_64 with Python 3.13 installed, choose rotel_py_processor_3.13_v0.0.1-alpha19_x86_64-unknown-linux-gnu.tar.gz.
- Build from source.
git clone git@github.com:streamfold/rotel.git; cd rotel
cargo build --features pyo3 --release