swarmauri_tool_jupyterreadnotebook 0.8.3.dev5

A tool that reads a Jupyter Notebook file using nbformat, converting the JSON file into a NotebookNode object.

---

Swarmauri Tool Jupyter Read Notebook

Reads a .ipynb file from disk into a validated nbformat NotebookNode for downstream processing.

Features

• Wraps nbformat’s read + validation workflow in a Swarmauri tool.
• Returns { "notebook_node": NotebookNode } on success or { "error": ... } on failure.
• Optional as_version argument controls notebook parsing version (default 4).

Prerequisites

• Python 3.10 or newer.
• nbformat installed (pulled automatically).

Installation

# pip
pip install swarmauri_tool_jupyterreadnotebook

# poetry
poetry add swarmauri_tool_jupyterreadnotebook

# uv (pyproject-based projects)
uv add swarmauri_tool_jupyterreadnotebook

Quickstart

from swarmauri_tool_jupyterreadnotebook import JupyterReadNotebookTool

reader = JupyterReadNotebookTool()
response = reader(
    notebook_file_path="notebooks/example.ipynb",
    as_version=4,
)

if "notebook_node" in response:
    nb = response["notebook_node"]
    print("Cells:", len(nb.cells))
else:
    print("Error:", response["error"])

Tips

• Use with execution/export tools to build pipelines (read → execute → convert).
• Handle error key gracefully when files are missing or malformed.

Want to help?

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