nbcat 0.12.0__tar.gz → 0.13.0__tar.gz

{nbcat-0.12.0 → nbcat-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbcat
-Version: 0.12.0
+Version: 0.13.0
 Summary: cat for jupyter notebooks
 Project-URL: Homepage, https://github.com/akopdev/nbcat
 Project-URL: Repository, https://github.com/akopdev/nbcat
@@ -33,6 +33,7 @@ Requires-Dist: argcomplete
 Requires-Dist: pydantic
 Requires-Dist: requests
 Requires-Dist: rich
+Requires-Dist: textual
 Requires-Dist: timg
 Provides-Extra: dev
 Requires-Dist: pytest; extra == 'dev'
@@ -52,9 +53,10 @@ Description-Content-Type: text/markdown
 
 ## Features
 
-- Very fast and lightweight with minimal dependencies
-- Preview remote notebooks without downloading them
-- Supports for all Jupyter notebook versions, including old legacy formats
+- Very fast and lightweight with minimal dependencies.
+- Preview remote notebooks without downloading them.
+- Enable paginated view mode with keyboard navigation (similar to `less`).
+- Supports for all Jupyter notebook versions, including old legacy formats.
 
 ## Motivation
 

{nbcat-0.12.0 → nbcat-0.13.0}/README.md

@@ -8,9 +8,10 @@
 
 ## Features
 
-- Very fast and lightweight with minimal dependencies
-- Preview remote notebooks without downloading them
-- Supports for all Jupyter notebook versions, including old legacy formats
+- Very fast and lightweight with minimal dependencies.
+- Preview remote notebooks without downloading them.
+- Enable paginated view mode with keyboard navigation (similar to `less`).
+- Supports for all Jupyter notebook versions, including old legacy formats.
 
 ## Motivation
 

{nbcat-0.12.0 → nbcat-0.13.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nbcat"
-version = "0.12.0"
+version = "0.13.0"
 description = "cat for jupyter notebooks"
 authors = [
     { name = "Akop Kesheshyan", email = "devnull@akop.dev" }
@@ -17,6 +17,7 @@ dependencies = [
     "pydantic",
     "rich",
     "timg",
+    "textual"
 ]
 
 [project.optional-dependencies]

nbcat-0.13.0/src/nbcat/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.13.0"

{nbcat-0.12.0 → nbcat-0.13.0}/src/nbcat/main.py

@@ -6,7 +6,6 @@ import argcomplete
 import requests
 from argcomplete.completers import FilesCompleter
 from pydantic import ValidationError
-from rich import box
 from rich.console import Console, Group, RenderableType
 from rich.padding import Padding
 from rich.panel import Panel
@@ -23,6 +22,7 @@ from .exceptions import (
 )
 from .image import Image
 from .markdown import Markdown
+from .pager import Pager
 from .schemas import Cell, Notebook
 
 console = Console()
@@ -87,10 +87,8 @@ def render_cell(cell: Cell) -> RenderableType:
     def _render_markdown(input: str) -> Markdown:
         return Markdown(input, code_theme="ansi_dark")
 
-    def _render_code(input: str, language: str = "python") -> Panel:
-        return Panel(
-            Syntax(input, language, line_numbers=True, theme="ansi_dark", dedent=True), padding=0
-        )
+    def _render_code(input: str, language: str = "python") -> Syntax:
+        return Syntax(input, language, theme="ansi_dark", padding=(1, 2), dedent=True)
 
     def _render_raw(input: str) -> Text:
         return Text(input)
@@ -116,41 +114,48 @@ def render_cell(cell: Cell) -> RenderableType:
     renderer = RENDERERS.get(cell.cell_type)
     source = renderer(cell.input) if renderer else None
     if source:
-        rows.append(Padding(source, (1, 0)))
+        s_title = f"[green]In [{cell.execution_count}][/]" if cell.execution_count else None
+        if s_title:
+            rows.append(Panel(source, title=s_title, title_align="left"))
+        else:
+            rows.append(Padding(source, (1, 0)))
+
         if not cell.outputs:
-            return source
+            return rows.pop()
 
     for o in cell.outputs:
+        o_title = f"[blue]Out [{o.execution_count}][/]" if o.execution_count else None
         if o.output:
             renderer = RENDERERS.get(o.output.output_type)
             output = renderer(o.output.text) if renderer else None
             if output:
-                rows.append(Panel(output, style="italic", box=box.MINIMAL))
+                if o_title:
+                    rows.append(Panel(output, style="italic", title=o_title, title_align="left"))
+                else:
+                    rows.append(Padding(output, (1, 0), style="italic"))
     return Group(*rows)
 
 
-def print_notebook(nb: Notebook):
+def render_notebook(nb: Notebook) -> list[RenderableType]:
     """
-    Print the notebook to the console with formatted cell inputs and outputs.
+    Convert a Notebook object into a list of rich renderables for terminal display.
+
+    Each cell in the notebook is processed and rendered using `render_cell`,
+    producing a sequence of styled input/output blocks suitable for use in a
+    Textual or Rich-based terminal UI.
 
     Args:
-        nb (Notebook): A Notebook object containing a list of cells.
-    """
-    if not nb.cells:
-        console.print("[bold red]Notebook contains no cells.")
-        return
+        nb (Notebook): The notebook object containing parsed cells (e.g., from a .ipynb file).
 
+    Returns
+    -------
+        list[RenderableType]: A list of rich renderable objects representing the notebook cells.
+                              Returns an empty list if the notebook has no cells.
+    """
+    rendered: list[RenderableType] = []
     for cell in nb.cells:
-        rendered = render_cell(cell)
-        if isinstance(rendered, Group):
-            out = Panel(
-                rendered,
-                title=f"[green][{cell.execution_count}][/]" if cell.execution_count else None,
-                title_align="left",
-            )
-        else:
-            out = Padding(rendered, (1, 0))
-        console.print(out)
+        rendered.append(render_cell(cell))
+    return rendered
 
 
 def main():
@@ -162,20 +167,38 @@ def main():
         "file", help="Path or URL to a .ipynb notebook", type=str
     ).completer = FilesCompleter()
     parser.add_argument(
+        "-v",
         "--version",
         help="print version information and quite",
         action="version",
         version=__version__,
     )
     parser.add_argument(
-        "--debug", help="enable extended error output", action="store_true", default=False
+        "-d", "--debug", help="enable extended error output", action="store_true", default=False
+    )
+    parser.add_argument(
+        "-p",
+        "--page",
+        help="enable paginated view mode (similar to less)",
+        action="store_true",
+        default=False,
     )
 
     try:
         argcomplete.autocomplete(parser)
         args = parser.parse_args()
+
         notebook = read_notebook(args.file, debug=args.debug)
-        print_notebook(notebook)
+        objects = render_notebook(notebook)
+
+        if not objects:
+            console.print("[bold red]Notebook contains no cells.")
+            return
+
+        if args.page:
+            Pager(objects).run()
+        else:
+            console.print(*objects)
     except Exception as e:
         sys.exit(f"nbcat: {e}")
 

nbcat-0.13.0/src/nbcat/pager.py

@@ -0,0 +1,82 @@
+from rich.console import RenderableType
+from textual.app import App, ComposeResult
+from textual.binding import Binding
+from textual.containers import VerticalScroll
+from textual.widgets import Static
+
+
+class Pager(App):
+    BINDINGS = [
+        # Exit
+        Binding("q", "quit", "Quit"),
+        Binding(":q", "quit", "Quit"),
+        Binding("Q", "quit", "Quit"),
+        Binding(":Q", "quit", "Quit"),
+        Binding("ZZ", "quit", "Quit"),
+        # One line
+        Binding("j", "scroll_down", "Down"),
+        Binding("e", "scroll_down", "Down"),
+        Binding("^e", "scroll_down", "Down"),
+        Binding("^n", "scroll_down", "Down"),
+        Binding("cr", "scroll_down", "Down"),  # carriage return = Enter
+        Binding("k", "scroll_up", "Up"),
+        Binding("y", "scroll_up", "Up"),
+        Binding("ctrl+y", "scroll_up", "Up"),
+        Binding("ctrl+k", "scroll_up", "Up"),
+        Binding("ctrl+p", "scroll_up", "Up"),
+        # One window
+        Binding("f", "page_down", "Page Down"),
+        Binding("ctrl+f", "page_down", "Page Down"),
+        Binding("ctrl+v", "page_down", "Page Down"),
+        Binding("space", "page_down", "Page Down"),
+        Binding("b", "page_up", "Page Up"),
+        Binding("ctrl+b", "page_up", "Page Up"),
+        Binding("escape+v", "page_up", "Page Up"),
+        # Extended window control
+        Binding("z", "page_down", "Window Down (set N)"),
+        Binding("w", "page_up", "Window Up (set N)"),
+        Binding("escape+space", "page_down", "Forward one window, no EOF stop"),
+        Binding("d", "half_page_down", "Half Page Down"),
+        Binding("ctrl+d", "half_page_down", "Half Page Down"),
+        # Jumping
+        Binding("g", "go_to_top", "Top of File"),
+        Binding("<", "go_to_top", "Top of File"),
+        Binding("escape+<", "go_to_top", "Top of File"),
+        Binding("G", "go_to_bottom", "Bottom of File"),
+        Binding(">", "go_to_bottom", "Bottom of File"),
+        Binding("escape+>", "go_to_bottom", "Bottom of File"),
+    ]
+
+    def __init__(self, objects: list[RenderableType]):
+        super().__init__()
+        self._objects = objects
+
+    def compose(self) -> ComposeResult:
+        with VerticalScroll():
+            for obj in self._objects:
+                yield Static(obj)
+
+    def on_mount(self) -> None:
+        self.theme = "textual-ansi"
+        self.viewer = self.query_one(VerticalScroll)
+
+    def action_scroll_down(self) -> None:
+        self.viewer.scroll_to(y=self.viewer.scroll_y + 1)
+
+    def action_scroll_up(self) -> None:
+        self.viewer.scroll_to(y=self.viewer.scroll_y - 1)
+
+    def action_page_down(self) -> None:
+        self.viewer.scroll_to(y=self.viewer.scroll_y + self.viewer.virtual_size.height)
+
+    def action_page_up(self) -> None:
+        self.viewer.scroll_to(y=max(self.viewer.scroll_y - self.viewer.virtual_size.height, 0))
+
+    def action_half_page_down(self) -> None:
+        self.viewer.scroll_to(y=self.viewer.scroll_y + (self.viewer.virtual_size.height / 2))
+
+    def action_go_to_top(self) -> None:
+        self.viewer.scroll_to(y=0)
+
+    def action_go_to_bottom(self) -> None:
+        self.viewer.scroll_to(y=self.viewer.virtual_size.height)

{nbcat-0.12.0 → nbcat-0.13.0}/tests/test_render_cell.py

@@ -1,29 +1,9 @@
-import pytest
-from rich.console import Group, RenderableType
-from rich.markdown import Markdown
-from rich.panel import Panel
-from rich.text import Text
+from rich.console import Group
 
 from nbcat.main import render_cell
 from nbcat.schemas import Cell, StreamOutput
 
 
-@pytest.mark.parametrize(
-    "cell_type,source,expected",
-    [
-        ("markdown", "# Heading", Markdown),
-        ("code", "print('Hello')", Panel),
-        ("raw", "Raw content", Text),
-        ("heading", "Heading text", Markdown),
-    ],
-)
-def test_render_cell_input_rendering(cell_type: str, source: str, expected: RenderableType):
-    cell = Cell(cell_type=cell_type, source=source, execution_count=42, outputs=[])
-    rendered = render_cell(cell)
-
-    assert isinstance(rendered, expected)
-
-
 def test_render_cell_with_outputs():
     output_1 = StreamOutput(text=["First output"], execution_count=7, output_type="stream")
     output_2 = StreamOutput(text=["Second output"], output_type="stream")

{nbcat-0.12.0 → nbcat-0.13.0}/uv.lock

@@ -214,6 +214,18 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/2c/e1/e6716421ea10d38022b952c159d5161ca1193197fb744506875fbb87ea7b/iniconfig-2.1.0-py3-none-any.whl", hash = "sha256:9deba5723312380e77435581c6bf4935c94cbfab9b1ed33ef8d238ea168eb760", size = 6050 },
 ]
 
+[[package]]
+name = "linkify-it-py"
+version = "2.0.3"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "uc-micro-py" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/2a/ae/bb56c6828e4797ba5a4821eec7c43b8bf40f69cda4d4f5f8c8a2810ec96a/linkify-it-py-2.0.3.tar.gz", hash = "sha256:68cda27e162e9215c17d786649d1da0021a451bdc436ef9e0fa0ba5234b9b048", size = 27946 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/04/1e/b832de447dee8b582cac175871d2f6c3d5077cc56d5575cadba1fd1cccfa/linkify_it_py-2.0.3-py3-none-any.whl", hash = "sha256:6bcbc417b0ac14323382aef5c5192c0075bf8a9d6b41820a2b66371eac6b6d79", size = 19820 },
+]
+
 [[package]]
 name = "markdown-it-py"
 version = "3.0.0"
@@ -226,6 +238,26 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/42/d7/1ec15b46af6af88f19b8e5ffea08fa375d433c998b8a7639e76935c14f1f/markdown_it_py-3.0.0-py3-none-any.whl", hash = "sha256:355216845c60bd96232cd8d8c40e8f9765cc86f46880e43a8fd22dc1a1a8cab1", size = 87528 },
 ]
 
+[package.optional-dependencies]
+linkify = [
+    { name = "linkify-it-py" },
+]
+plugins = [
+    { name = "mdit-py-plugins" },
+]
+
+[[package]]
+name = "mdit-py-plugins"
+version = "0.4.2"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "markdown-it-py" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/19/03/a2ecab526543b152300717cf232bb4bb8605b6edb946c845016fa9c9c9fd/mdit_py_plugins-0.4.2.tar.gz", hash = "sha256:5f2cd1fdb606ddf152d37ec30e46101a60512bc0e5fa1a7002c36647b09e26b5", size = 43542 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/a7/f7/7782a043553ee469c1ff49cfa1cdace2d6bf99a1f333cf38676b3ddf30da/mdit_py_plugins-0.4.2-py3-none-any.whl", hash = "sha256:0c673c3f889399a33b95e88d2f0d111b4447bdfea7f237dab2d488f459835636", size = 55316 },
+]
+
 [[package]]
 name = "mdurl"
 version = "0.1.2"
@@ -237,13 +269,14 @@ wheels = [
 
 [[package]]
 name = "nbcat"
-version = "0.12.0"
+version = "0.13.0"
 source = { editable = "." }
 dependencies = [
     { name = "argcomplete" },
     { name = "pydantic" },
     { name = "requests" },
     { name = "rich" },
+    { name = "textual" },
     { name = "timg" },
 ]
 
@@ -267,6 +300,7 @@ requires-dist = [
     { name = "requests" },
     { name = "rich" },
     { name = "ruff", marker = "extra == 'dev'" },
+    { name = "textual" },
     { name = "timg" },
 ]
 provides-extras = ["dev"]
@@ -368,6 +402,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/21/2c/5e05f58658cf49b6667762cca03d6e7d85cededde2caf2ab37b81f80e574/pillow-11.2.1-pp311-pypy311_pp73-win_amd64.whl", hash = "sha256:208653868d5c9ecc2b327f9b9ef34e0e42a4cdd172c2988fd81d62d2bc9bc044", size = 2674751 },
 ]
 
+[[package]]
+name = "platformdirs"
+version = "4.3.8"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/fe/8b/3c73abc9c759ecd3f1f7ceff6685840859e8070c4d947c93fae71f6a0bf2/platformdirs-4.3.8.tar.gz", hash = "sha256:3d512d96e16bcb959a814c9f348431070822a6496326a4be0911c40b5a74c2bc", size = 21362 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/fe/39/979e8e21520d4e47a0bbe349e2713c0aac6f3d853d0e5b34d76206c439aa/platformdirs-4.3.8-py3-none-any.whl", hash = "sha256:ff7059bb7eb1179e2685604f4aaf157cfd9535242bd23742eadc3c13542139b4", size = 18567 },
+]
+
 [[package]]
 name = "pluggy"
 version = "1.5.0"
@@ -685,6 +728,21 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/68/ca/69d7c7752bce162d1516e5592b1cc6b6668e9328c0d270609ddbeeadd7cf/ruff-0.11.7-py3-none-win_arm64.whl", hash = "sha256:778c1e5d6f9e91034142dfd06110534ca13220bfaad5c3735f6cb844654f6177", size = 10677936 },
 ]
 
+[[package]]
+name = "textual"
+version = "3.2.0"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "markdown-it-py", extra = ["linkify", "plugins"] },
+    { name = "platformdirs" },
+    { name = "rich" },
+    { name = "typing-extensions" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/34/99/8408761a1a1076b2bb69d4859ec110d74be7515552407ac1cb6b68630eb6/textual-3.2.0.tar.gz", hash = "sha256:d2f3b0c39e02535bb5f2aec1c45e10bd3ee7508ed1e240b7505c3cf02a6f00ed", size = 1607281 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/10/d0/5869999e03ec4ad3a80f36298eb018556faaae0d3309dc305ecd93450b06/textual-3.2.0-py3-none-any.whl", hash = "sha256:c857c6d8dfc9aa915e09df99d227cbe1da3a7ea500b45af9f6b3ecb810c00d77", size = 685595 },
+]
+
 [[package]]
 name = "timg"
 version = "1.1.6"
@@ -757,6 +815,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/31/08/aa4fdfb71f7de5176385bd9e90852eaf6b5d622735020ad600f2bab54385/typing_inspection-0.4.0-py3-none-any.whl", hash = "sha256:50e72559fcd2a6367a19f7a7e610e6afcb9fac940c650290eed893d61386832f", size = 14125 },
 ]
 
+[[package]]
+name = "uc-micro-py"
+version = "1.0.3"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/91/7a/146a99696aee0609e3712f2b44c6274566bc368dfe8375191278045186b8/uc-micro-py-1.0.3.tar.gz", hash = "sha256:d321b92cff673ec58027c04015fcaa8bb1e005478643ff4a500882eaab88c48a", size = 6043 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/37/87/1f677586e8ac487e29672e4b17455758fce261de06a0d086167bb760361a/uc_micro_py-1.0.3-py3-none-any.whl", hash = "sha256:db1dffff340817673d7b466ec86114a9dc0e9d4d9b5ba229d9d60e5c12600cd5", size = 6229 },
+]
+
 [[package]]
 name = "urllib3"
 version = "2.4.0"

nbcat-0.12.0/src/nbcat/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.12.0"