swarmauri_tool_jupyterexecuteandconvert 0.11.0.dev1

Swarmauri notebook publishing tool for executing Jupyter notebooks and converting them to rendered output formats.

Swarmauri Jupyter Execute And Convert Tool

swarmauri_tool_jupyterexecuteandconvert runs a notebook through the jupyter nbconvert CLI, writes an executed notebook artifact, and then converts that executed notebook to a target output format such as HTML or PDF.

Why

• Execute notebooks and publish rendered artifacts in one Swarmauri tool call.
• Keep notebook reporting workflows inside a simple automation surface.
• Produce web or document outputs from the exact executed notebook state.

Features

• Verifies the source notebook exists before execution.
• Executes notebooks with jupyter nbconvert --execute.
• Converts the executed notebook in a second nbconvert step.
• Supports html and pdf output formats.
• Returns either {"converted_file": ..., "status": "success"} or an error payload.

FAQ

What file does this tool convert?

It first creates an executed notebook named executed_<original>.ipynb, then converts that executed notebook to the requested format.

Does this return notebook content?

No. It returns metadata about the produced converted file, not the notebook object itself.

When should I use this instead of swarmauri_tool_jupyterexecutenotebook?

Use this package when you want rendered artifacts like HTML or PDF. Use swarmauri_tool_jupyterexecutenotebook when you want the executed NotebookNode in memory.

Installation

uv add swarmauri_tool_jupyterexecuteandconvert

pip install swarmauri_tool_jupyterexecuteandconvert

Usage

from swarmauri_tool_jupyterexecuteandconvert import JupyterExecuteAndConvertTool

tool = JupyterExecuteAndConvertTool()
result = tool(
    notebook_path="reports/weekly.ipynb",
    output_format="html",
    execution_timeout=300,
)

print(result)

Examples

Execute a notebook and export HTML

response = JupyterExecuteAndConvertTool()(
    notebook_path="reports/status.ipynb",
    output_format="html",
    execution_timeout=120,
)

print(response["converted_file"])

Execute a notebook and export PDF

response = JupyterExecuteAndConvertTool()(
    notebook_path="reports/board_packet.ipynb",
    output_format="pdf",
    execution_timeout=600,
)

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

Related Packages

• swarmauri_tool_jupyterexecutenotebook
• swarmauri_tool_jupyterexecutenotebookwithparameters
• swarmauri_tool_jupyterexporthtml
• swarmauri_tool_jupyterexportlatex
• swarmauri_tool_jupyterexportpython

Foundational Swarmauri Packages

• swarmauri
• swarmauri_core
• swarmauri_base
• swarmauri_standard

More Documentation

• Swarmauri SDK repository
• nbconvert documentation
• Jupyter documentation