notebookllm 1.0

No project description provided

notebookllm

A Python package to bridge the gap between Jupyter Notebooks and Large Language Models (LLMs).

Why this package?

Current Large Language Models (LLMs) cannot directly read or process .ipynb files. This package provides a solution by converting .ipynb files to a simplified plain text format that LLMs can easily understand. It also allows converting Python files to .ipynb files.

Features

• Convert .ipynb files to a simplified plain text (.py, .txt or .r file) format.
• Convert Python or R (.py, .txt or .r files) to .ipynb files.
• The plain text (.py, .txt or .r) format preserves the structure of the notebook, including code and markdown cells, using # %% [code] and # %% [markdown] identifiers.
• The plain text (.py, .txt or .r) format can be easily parsed back into a .ipynb file.

Installation

pip install notebookllm

or

git clone https://github.com/yasirrazaa/notebookllm.git
cd notebookllm
pip install .  

Usage

CLI

to_text

Converts a .ipynb file to a simplified plain text format.

Usage:

notebookllm to_text <ipynb_file> --output <output_file>

• <ipynb_file>: Path to the .ipynb file.
• --output <output_file>: Path to save the plain text output. If not provided, the output will be printed to the console.

Example:

notebookllm to_text my_notebook.ipynb --output my_notebook.txt

to_ipynb

Converts a .py file to a .ipynb file.

Usage:

notebookllm to_ipynb <py_file> --output <output_file>

• <py_file>: Path to the .py file.
• --output <output_file>: Path to save the .ipynb output. If not provided, the output will be saved to output.ipynb.

Example:

notebookllm to_ipynb my_script.py --output my_notebook.ipynb

API

from notebookllm import Notebook

notebook = Notebook(filepath='notebook.ipynb')  # Load existing notebook or create a new one
notebook.add_code_cell('print("Hello, world!")') # Add a code cell
notebook.add_markdown_cell('# This is a markdown cell') # Add a markdown cell
notebook.execute_cell(0) # Execute a cell
notebook.delete_cell(1) # Delete a cell
notebook.add_raw_cell('{"data": {"text/plain": "This is a raw cell"}}') # Add a raw cell
notebook.save('new_notebook.ipynb') # Save the notebook
notebook.edit_cell(0, 'print("Hello, world!")') # Edit a cell
notebook.save() # Save the changes