swarmauri_tool_jupytervalidatenotebook 0.11.0.dev1

Swarmauri notebook-governance tool for validating Jupyter notebook objects against nbformat schema rules.

Swarmauri Jupyter Validate Notebook Tool

swarmauri_tool_jupytervalidatenotebook validates a notebook object against Jupyter notebook schema rules with nbformat and returns a structured validity report for Swarmauri notebook workflows.

Why

• Catch notebook structure problems before execution or export.
• Add a simple schema-validation gate to notebook automation pipelines.
• Standardize notebook health checks behind a Swarmauri tool contract.

Features

• Accepts notebook objects compatible with nbformat.
• Enforces nbformat == 4 before schema validation.
• Validates notebook structure with nbformat.validate.
• Returns valid and report fields for downstream flow control.
• Handles validation and unexpected runtime failures explicitly.

FAQ

What does this tool return?

It returns a dictionary with valid set to "True" or "False" and a human-readable report describing the outcome.

Does this tool accept notebook file paths?

No. It expects a notebook object, not a path and not a JSON string.

Why does it reject notebooks with the wrong nbformat?

The implementation explicitly requires Jupyter notebook format version 4 before calling schema validation.

Installation

uv add swarmauri_tool_jupytervalidatenotebook

pip install swarmauri_tool_jupytervalidatenotebook

Usage

from swarmauri_tool_jupytervalidatenotebook import JupyterValidateNotebookTool

notebook = {
    "nbformat": 4,
    "nbformat_minor": 5,
    "cells": [],
    "metadata": {},
}

result = JupyterValidateNotebookTool()(notebook=notebook)
print(result)

Examples

Validate a notebook before execution

validator = JupyterValidateNotebookTool()
result = validator(
    notebook={
        "nbformat": 4,
        "nbformat_minor": 5,
        "cells": [],
        "metadata": {},
    }
)

if result["valid"] == "True":
    print("Notebook passed validation")

Detect invalid notebook version

result = JupyterValidateNotebookTool()(
    notebook={
        "nbformat": 3,
        "nbformat_minor": 0,
        "cells": [],
        "metadata": {},
    }
)

print(result["report"])

Related Packages

• swarmauri_tool_jupyterfromdict
• swarmauri_tool_jupyterreadnotebook
• swarmauri_tool_jupyterwritenotebook
• swarmauri_tool_jupyterexecutenotebook
• swarmauri_tool_jupyterclearoutput

Foundational Swarmauri Packages

• swarmauri
• swarmauri_core
• swarmauri_base
• swarmauri_standard

More Documentation

• Swarmauri SDK repository
• nbformat documentation
• Jupyter documentation