swarmauri_tool_jupyterexportmarkdown 1.4.1.dev3

A Swarmauri tool designed to export Jupyter Notebooks to Markdown.

Swarmauri Tool Jupyter Export Markdown

Converts a Jupyter NotebookNode to Markdown using nbconvert’s MarkdownExporter. Injectable CSS and JS snippets let you tweak the output for static publishing.

Features

• Accepts a notebook JSON string and returns rendered Markdown.
• Optional inline CSS/JS injection to customize the exported document.
• Returns a dict with exported_markdown or error if conversion fails.

Prerequisites

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

Installation

# pip
pip install swarmauri_tool_jupyterexportmarkdown

# poetry
poetry add swarmauri_tool_jupyterexportmarkdown

# uv (pyproject-based projects)
uv add swarmauri_tool_jupyterexportmarkdown

Quickstart

import json
import nbformat
from swarmauri_tool_jupyterexportmarkdown import JupyterExportMarkdownTool

notebook = nbformat.read("notebooks/example.ipynb", as_version=4)
notebook_json = json.dumps(notebook)

exporter = JupyterExportMarkdownTool()
response = exporter(
    notebook_json=notebook_json,
    extra_css="blockquote { color: gray; }",
    extra_js="console.log('Markdown ready');",
)

if "exported_markdown" in response:
    Path("notebooks/example.md").write_text(response["exported_markdown"], encoding="utf-8")
else:
    print("Error:", response["error"])

Tips

• Use Markdown export when preparing notebooks for static docs, blogs, or README content.
• Apply lightweight CSS/JS to adjust styling when the Markdown is embedded in HTML environments.
• Combine with notebook execution tools to build pipelines (execute → convert to Markdown → publish).

Want to help?

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