lysqlnb 0.2.0__tar.gz → 0.3.0__tar.gz

{lysqlnb-0.2.0 → lysqlnb-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lysqlnb
-Version: 0.2.0
+Version: 0.3.0
 Summary: A library for reading and validating SQL notebook files.
 Keywords: notebook,sql
 Author: Leyton Addison-Roach
@@ -41,9 +41,9 @@ The data models are based on the VS Code [NotebookSerializer API](https://code.v
 
 ```python
 >>> from pathlib import Path
->>> from lysqlnb import Notebook
->>> notebook = Notebook.from_file(Path("path/to/notebook.sqlnb"))
->>> notebook.model_dump_json(indent=2)
+>>> import lysqlnb as sqlnb
+>>> nb = sqlnb.load(Path("path/to/notebook.sqlnb"))
+>>> nb.model_dump_json(indent=2)
 {
   "cells": [
     {

{lysqlnb-0.2.0 → lysqlnb-0.3.0}/README.md

@@ -19,9 +19,9 @@ The data models are based on the VS Code [NotebookSerializer API](https://code.v
 
 ```python
 >>> from pathlib import Path
->>> from lysqlnb import Notebook
->>> notebook = Notebook.from_file(Path("path/to/notebook.sqlnb"))
->>> notebook.model_dump_json(indent=2)
+>>> import lysqlnb as sqlnb
+>>> nb = sqlnb.load(Path("path/to/notebook.sqlnb"))
+>>> nb.model_dump_json(indent=2)
 {
   "cells": [
     {

{lysqlnb-0.2.0 → lysqlnb-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lysqlnb"
-version = "0.2.0"
+version = "0.3.0"
 description = "A library for reading and validating SQL notebook files."
 readme = "README.md"
 license = "MIT"

lysqlnb-0.3.0/src/lysqlnb/__init__.py

@@ -0,0 +1,57 @@
+"""lysqlnb — a library for reading and validating SQL notebook files."""
+
+from typing import TYPE_CHECKING
+
+from lysqlnb.exceptions import NotebookParseError
+from lysqlnb.loader import loads as _loads
+from lysqlnb.models import (
+    Notebook,
+    NotebookCell,
+    NotebookCellKind,
+    NotebookCellLanguage,
+)
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+__all__ = [
+    "Notebook",
+    "NotebookCell",
+    "NotebookCellKind",
+    "NotebookCellLanguage",
+    "NotebookParseError",
+    "load",
+    "loads",
+]
+
+
+def loads(s: str) -> Notebook:
+    """Load a notebook from a string.
+
+    Args:
+        s: String to load the notebook from.
+
+    Returns:
+        Notebook data object.
+
+    Raises:
+        NotebookParseError: If the string contains invalid YAML or
+            does not conform to the notebook schema.
+    """
+    return _loads(s)
+
+
+def load(path: Path) -> Notebook:
+    """Load a notebook from a file path.
+
+    Args:
+        path: Path to the notebook file.
+
+    Returns:
+        Notebook data object.
+
+    Raises:
+        NotebookParseError: If the file contains invalid YAML or
+            does not conform to the notebook schema.
+    """
+    return loads(path.read_text(encoding="utf-8"))

lysqlnb-0.3.0/src/lysqlnb/loader.py

@@ -0,0 +1,35 @@
+"""YAML parsing and validation for notebook files."""
+
+from typing import Any
+
+import yaml
+from pydantic import ValidationError
+
+from lysqlnb.exceptions import NotebookParseError
+from lysqlnb.models import Notebook
+
+
+def loads(s: str) -> Notebook:
+    """Load a raw YAML string into a notebook.
+
+    Args:
+        s: YAML string to load.
+
+    Returns:
+        Notebook data object.
+
+    Raises:
+        NotebookParseError: If the string contains invalid YAML or
+            does not conform to the notebook schema.
+    """
+    try:
+        raw: Any = yaml.safe_load(s)
+    except yaml.YAMLError as e:
+        msg = f"Invalid YAML: {e}"
+        raise NotebookParseError(msg) from e
+
+    try:
+        return Notebook.model_validate(raw)
+    except ValidationError as e:
+        msg = f"Invalid notebook structure: {e}"
+        raise NotebookParseError(msg) from e

{lysqlnb-0.2.0 → lysqlnb-0.3.0}/src/lysqlnb/models.py

@@ -1,15 +1,8 @@
-"""Notebook data models and parsing."""
+"""Notebook data models."""
 
 from enum import IntEnum, StrEnum
-from typing import TYPE_CHECKING, Any
 
-import yaml
-from pydantic import BaseModel, ConfigDict, Field, ValidationError
-
-from lysqlnb.exceptions import NotebookParseError
-
-if TYPE_CHECKING:
-    from pathlib import Path
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class NotebookCellKind(IntEnum):
@@ -68,29 +61,3 @@ class Notebook(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
     cells: list[NotebookCell]
-
-    @classmethod
-    def from_file(cls, path: Path) -> Notebook:
-        """Create a notebook from a file.
-
-        Args:
-            path: Path to the notebook file.
-
-        Returns:
-            Validated notebook data object.
-
-        Raises:
-            NotebookParseError: If the file contains invalid YAML or
-                does not conform to the notebook schema.
-        """
-        try:
-            raw: Any = yaml.safe_load(path.read_text(encoding="utf-8"))
-        except yaml.YAMLError as e:
-            msg = f"Invalid YAML: {e}"
-            raise NotebookParseError(msg) from e
-
-        try:
-            return cls.model_validate(raw)
-        except ValidationError as e:
-            msg = f"Invalid notebook structure: {e}"
-            raise NotebookParseError(msg) from e

lysqlnb-0.2.0/src/lysqlnb/__init__.py

@@ -1,17 +0,0 @@
-"""lysqlnb — a library for reading and validating SQL notebook files."""
-
-from lysqlnb.exceptions import NotebookParseError
-from lysqlnb.models import (
-    Notebook,
-    NotebookCell,
-    NotebookCellKind,
-    NotebookCellLanguage,
-)
-
-__all__ = [
-    "Notebook",
-    "NotebookCell",
-    "NotebookCellKind",
-    "NotebookCellLanguage",
-    "NotebookParseError",
-]