swarmauri_tool_jupyterexecutenotebookwithparameters 1.4.1.dev3

A tool designed to execute parameterized notebooks using papermill, allowing dynamic input and output capture for automated workflows.

Swarmauri Tool Jupyter Execute Notebook With Parameters

Runs a Jupyter notebook with injected parameters using Papermill-style execution.

Features

• Parameterizes notebooks via Papermill and executes them end-to-end.
• Saves the executed notebook to an output path of your choice.
• Returns a dict containing executed_notebook on success or error/message when execution fails.

Prerequisites

• Python 3.10 or newer.
• Papermill, nbformat, nbconvert, swarmauri base/core packages (installed automatically).
• Notebook dependencies must be available in the runtime environment.

Installation

# pip
pip install swarmauri_tool_jupyterexecutenotebookwithparameters

# poetry
poetry add swarmauri_tool_jupyterexecutenotebookwithparameters

# uv (pyproject-based projects)
uv add swarmauri_tool_jupyterexecutenotebookwithparameters

Quickstart

from swarmauri_tool_jupyterexecutenotebookwithparameters import JupyterExecuteNotebookWithParametersTool

executor = JupyterExecuteNotebookWithParametersTool()
response = executor(
    notebook_path="templates/report.ipynb",
    output_notebook_path="outputs/report-filled.ipynb",
    params={
        "input_data_path": "data/input.csv",
        "run_mode": "production",
    },
    timeout=600,
)

if "executed_notebook" in response:
    print("Notebook executed:", response["executed_notebook"])
else:
    print("Error:", response["error"], response.get("message"))

Tips

• Parameters can be any JSON-serializable values used inside the notebook (strings, numbers, dictionaries, etc.).
• Increase timeout for notebooks with lengthy cells.
• Combine with Swarmauri notebook cleaning/conversion tools for full pipelines (execute → clear outputs → convert to PDF/HTML).

Want to help?

If you want to contribute to swarmauri-sdk, read up on our guidelines for contributing that will help you get started.