lysqlnb 0.1.0

A library for reading and validating SQL notebook files.

lysqlnb

A library for reading and validating SQL notebook files (.sqlnb).

[!WARNING] This project is a work in progress and is not yet ready for use. The API is unstable and subject to breaking changes.

Installation

pip install lysqlnb

Background

The data models are based on the VS Code NotebookSerializer API.

Usage

>>> from pathlib import Path
>>> from lysqlnb import NotebookData
>>> notebook = NotebookData.from_file(Path("path/to/notebook.sqlnb"))
>>> print(notebook.model_dump_json(indent=2))
{
  "cells": [
    {
      "kind": 1,
      "value": "# This is Markdown.",
      "language_id": "markdown"
    },
    {
      "kind": 2,
      "value": "SELECT * FROM departments;",
      "language_id": "oracle-sql"
    }
  ]
}

Requirements

Python 3.14+

Licence

MIT