Python SDK

The Fused Python SDK (fused-py) exposes utility functions to write, manage, and run Fused UDFs. Use it in the UDF Builder or install it in your preferred Python environment.

Documentation overview

📄️ Top-Level Functions

@fused.udf

🗃️ API Reference

3 items

📄️ Authentication

Authenticate Jupyter Notebooks to use the Fused Python SDK

📄️ Changelog

v1.14.0 (2025-02-25)

Install

note

This step is only required if you're running fused on your end (locally or in a development environment). If you're working in Workbench UDF Builder or App Builder fused is already installed for you.

1. Set up a Python environment:

We're using venv but you could use conda or any other environment manager in Python.

python3 -m venv .venv
source .venv/bin/activate

2. Install the fused package:

Install the base package:

pip install fused

Or install with optional dependencies:

# For raster data processing
pip install "fused[raster]"

# For vector data processing
pip install "fused[vector]"

# Install all optional dependencies
pip install "fused[all]"

3. Authenticate:

In a notebook

from fused.api import NotebookCredentials
credentials = NotebookCredentials()

Run this snippet from a Notebook Cell and follow the authentication flow, which will store a credentials file in ~/.fused/credentials.