Brokoli
Python SDK

Python SDK Installation

Install the Brokoli Python SDK to define pipelines as code.

Install the Brokoli Python SDK to define pipelines as code.

Requirements

  • Python 3.9 or later
  • A running Brokoli server (for deployment)

Install

pip install brokoli

Verify

import brokoli
print(brokoli.__version__)

Or from the command line:

brokoli --version

CLI commands

The SDK includes a CLI for managing pipelines:

CommandDescription
brokoli deployDeploy a pipeline to the server
brokoli validateValidate a pipeline file without deploying
brokoli compileOutput pipeline JSON to stdout
brokoli exportExport pipeline JSON to a file

Configuration

Set the server URL via environment variable or CLI flag:

export BROKOLI_SERVER=http://localhost:8080
export BROKOLI_API_KEY=brk_your_key_here

Or per-command:

brokoli deploy my_pipeline.py --server http://localhost:8080 --api-key brk_xxx

Optional dependencies

For Code nodes that process large datasets, install these for faster data transfer:

pip install pyarrow pandas

Brokoli auto-detects pyarrow and pandas at runtime and uses them for file-based data transfer when datasets exceed 10,000 rows.

Next steps