Python API Introduction

The Wallaroo Python API can be used to write Wallaroo applications entirely in Python without needing Java or a JVM. This lets developers quickly get started with Wallaroo by leveraging their existing Python knowledge. It currently supports Python 2.7. Support for Python 3.X is in the works and we encourage you to contact us if that is a requirement.

In order to write a Wallaroo application in Python, the developer creates the functions (decorated with the Wallaroo API) to be run at each step of their application, along with an entry point function that uses the Wallaroo ApplicationBuilder that defines the layout of their application.

For a basic overview of what Wallaroo does, read What is Wallaroo and Core Concepts. These documents will help you understand the system at a high level so that you can see how the pieces of the Python API fit into it.


Machida is the program that runs Wallaroo applications written using the Wallaroo Python API. It takes a module name as its --application-module argument and requires a method called application_setup(...) to be defined in that module. This method returns the structure describing the Wallaroo application in terms of Python objects, which is then used to coordinate calling those objects’ methods with the appropriate arguments as the application is running.

Machida runs Wallaroo Python applications using an embedded CPython interpreter. You should be able to use any Python modules that you would normally use when creating a Python application.

Python Packages

Wallaroo programs that use the Python API can use any packages that would be used with a normal Python program, including your own packages and third party packages. In order to use them, they must be installed on every machine in the Wallaroo cluster and must be accessible via the PYTHONPATH.

We recommend using virtualenv with Wallaroo. See Wallaroo and Virtualenv for set up and usage instructions.

Next Steps

To set up your environment for writing and running Wallaroo Python application, refer to our installation instructions.

results matching ""

    No results matching ""