nb4llm: Notebook ↔ LLM Text Converter

Welcome to nb4llm’s documentation!

nb4llm is a Python tool and library for converting Jupyter notebooks to and from a readable, LLM-friendly text format. It is designed for scientists, data scientists, and anyone who wants to make notebooks more accessible to large language models or other text-based tools.

Features

• Convert .ipynb to readable .txt (and back!)

• Preserves code cell language (Python, R, Julia, …)

• Handles nested code fences and markdown

• CLI and Python API

• Numpydoc-style docstrings for easy API browsing

Contents:

• nb4llm CLI Tutorial
  • Basic Usage
    • Convert a notebook to text
    • Convert a notebook to a specific text file
    • Convert text back to a notebook
    • Convert text to a specific notebook file
    • Show help
  • Options
  • Example Workflow
  • Advanced
• API Reference
  • convert_ipynb_to_txt()
  • convert_txt_to_ipynb()
  • get_fence()
  • main()

Quick Start

# Convert a notebook to text
nb4llm my_notebook.ipynb

# Convert text back to a notebook
nb4llm --reverse my_notebook.txt

See the nb4llm CLI Tutorial for more details and examples.

API Reference

See API Reference for the Python API documentation.

Indices and tables

• Index

• Module Index

• Search Page