swarmauri_tool_jupyterexecuteandconvert 0.9.3.dev3

A tool that programmatically executes and converts a Jupyter Notebook using nbconvert's CLI functionality, enabling automated notebook execution and format conversion.

---

Swarmauri Tool Jupyter Execute & Convert

Executes a Jupyter notebook and converts the output to HTML or PDF using nbconvert—packaged as a Swarmauri tool.

Features

• Runs notebooks with configurable execution timeout.
• Converts executed notebooks to html or pdf via nbconvert.
• Returns a status dictionary with the converted file path or error details.

Prerequisites

• Python 3.10 or newer.
• nbconvert, nbformat, and Jupyter runtime (installed automatically).
• Notebook dependencies must be available in the execution environment.

Installation

# pip
pip install swarmauri_tool_jupyterexecuteandconvert

# poetry
poetry add swarmauri_tool_jupyterexecuteandconvert

# uv (pyproject-based projects)
uv add swarmauri_tool_jupyterexecuteandconvert

Quickstart

from swarmauri_tool_jupyterexecuteandconvert import JupyterExecuteAndConvertTool

tool = JupyterExecuteAndConvertTool()
response = tool(
    notebook_path="notebooks/analysis.ipynb",
    output_format="pdf",
    execution_timeout=600,
)

if response.get("status") == "success":
    print("Converted file:", response["converted_file"])
else:
    print("Error:", response.get("error"))
    print("Message:", response.get("message"))

Tips

• Set execution_timeout high enough for long-running notebooks; nbconvert defaults to 600 seconds.
• Ensure notebooks run headlessly: avoid widgets or interactive inputs that pause execution.
• Install LaTeX (tectonic, texlive) if exporting to PDF on systems where nbconvert requires it.
• Combine with JupyterClearOutputTool to strip outputs after conversion if you want clean notebooks and rich artifacts.

Want to help?

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