swarmauri_tool_jupyterexecutenotebookwithparameters 0.11.0.dev1

Swarmauri papermill tool for executing parameterized Jupyter notebooks and writing executed notebook outputs.

Swarmauri Jupyter Execute Notebook With Parameters Tool

swarmauri_tool_jupyterexecutenotebookwithparameters executes parameterized Jupyter notebooks through papermill, injects runtime parameters, and writes the executed notebook to a target output path.

Why

• Turn notebooks into repeatable jobs with runtime inputs.
• Generate environment-specific notebook runs without hand-editing source notebooks.
• Use papermill-backed parameter injection inside Swarmauri workflows.

Features

• Executes .ipynb notebooks with papermill.execute_notebook.
• Injects a dictionary of runtime parameters.
• Writes results to a caller-provided output notebook path.
• Validates that both input and output paths are notebook files.
• Returns either {"executed_notebook": ...} or {"error": ...}.

FAQ

When should I use this package instead of swarmauri_tool_jupyterexecutenotebook?

Use this package when the notebook needs injected parameters and a persisted executed output file. Use swarmauri_tool_jupyterexecutenotebook for direct in-memory execution and a returned NotebookNode.

Does this tool require .ipynb paths?

Yes. Both notebook_path and output_notebook_path must end with .ipynb, or the tool returns an error.

What does the parameter payload look like?

It is a plain Python dictionary that papermill passes into the notebook parameter cell.

Installation

uv add swarmauri_tool_jupyterexecutenotebookwithparameters

pip install swarmauri_tool_jupyterexecutenotebookwithparameters

Usage

from swarmauri_tool_jupyterexecutenotebookwithparameters import (
    JupyterExecuteNotebookWithParametersTool,
)

tool = JupyterExecuteNotebookWithParametersTool()
result = tool(
    notebook_path="templates/report.ipynb",
    output_notebook_path="artifacts/report-executed.ipynb",
    params={"region": "us", "day": "2026-05-24"},
)

print(result)

Examples

Execute a report notebook for a specific tenant

tool = JupyterExecuteNotebookWithParametersTool()

response = tool(
    notebook_path="reports/monthly.ipynb",
    output_notebook_path="artifacts/monthly-acme.ipynb",
    params={"tenant_id": "acme", "month": "2026-05"},
)

print(response["executed_notebook"])

Handle invalid notebook extensions

response = JupyterExecuteNotebookWithParametersTool()(
    notebook_path="reports/monthly.txt",
    output_notebook_path="artifacts/monthly.ipynb",
)

if "error" in response:
    print(response["error"])

Related Packages

• swarmauri_tool_jupyterexecutenotebook
• swarmauri_tool_jupyterreadnotebook
• swarmauri_tool_jupyterwritenotebook
• swarmauri_tool_jupyterexecuteandconvert
• swarmauri_tool_jupyterclearoutput

Foundational Swarmauri Packages

• swarmauri
• swarmauri_core
• swarmauri_base
• swarmauri_standard

More Documentation

• Swarmauri SDK repository
• Papermill documentation
• Jupyter notebook documentation