nbcat 0.12.1__py3-none-any.whl → 0.13.1__py3-none-any.whl

nbcat/__init__.py

@@ -1 +1 @@
-__version__ = "0.12.1"
+__version__ = "0.13.1"

nbcat/main.py

@@ -5,6 +5,7 @@ from pathlib import Path
 import argcomplete
 import requests
 from argcomplete.completers import FilesCompleter
+from markdownify import markdownify
 from pydantic import ValidationError
 from rich.console import Console, Group, RenderableType
 from rich.padding import Padding
@@ -22,6 +23,7 @@ from .exceptions import (
 )
 from .image import Image
 from .markdown import Markdown
+from .pager import Pager
 from .schemas import Cell, Notebook
 
 console = Console()
@@ -84,7 +86,7 @@ def render_cell(cell: Cell) -> RenderableType:
     """
 
     def _render_markdown(input: str) -> Markdown:
-        return Markdown(input, code_theme="ansi_dark")
+        return Markdown(markdownify(input), code_theme="ansi_dark")
 
     def _render_code(input: str, language: str = "python") -> Syntax:
         return Syntax(input, language, theme="ansi_dark", padding=(1, 2), dedent=True)
@@ -135,20 +137,26 @@ def render_cell(cell: Cell) -> RenderableType:
     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)
-        console.print(rendered)
+        rendered.append(render_cell(cell))
+    return rendered
 
 
 def main():
@@ -160,20 +168,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/markdown.py

@@ -41,16 +41,17 @@ class ImageItem(md.ImageItem):
     def __rich_console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
         image_content = None
         path = Path(self.destination)
-        if path.exists():
-            image_content = path.read_bytes()
-        elif self.destination.startswith("http://") or self.destination.startswith("https://"):
-            try:
-                with requests.Session() as req:
-                    res = req.get(self.destination, timeout=5)
-                    res.raise_for_status()
-                    image_content = res.content
-            except requests.RequestException:
-                return super().__rich_console__(console, options)
+        if path.suffix in [".png", ".jpeg", ".jpg"]:
+            if path.exists():
+                image_content = path.read_bytes()
+            elif self.destination.startswith("http://") or self.destination.startswith("https://"):
+                try:
+                    with requests.Session() as req:
+                        res = req.get(self.destination, timeout=5)
+                        res.raise_for_status()
+                        image_content = res.content
+                except requests.RequestException:
+                    return super().__rich_console__(console, options)
         if image_content:
             # TODO: This part can be improved by changing Image class to accept file objects
             image = base64.b64encode(image_content).decode("utf-8")

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.1.dist-info → nbcat-0.13.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbcat
-Version: 0.12.1
+Version: 0.13.1
 Summary: cat for jupyter notebooks
 Project-URL: Homepage, https://github.com/akopdev/nbcat
 Project-URL: Repository, https://github.com/akopdev/nbcat
@@ -30,9 +30,11 @@ License: MIT License
 License-File: LICENSE
 Requires-Python: >=3.9
 Requires-Dist: argcomplete
+Requires-Dist: markdownify
 Requires-Dist: pydantic
 Requires-Dist: requests
 Requires-Dist: rich
+Requires-Dist: textual
 Requires-Dist: timg
 Provides-Extra: dev
 Requires-Dist: pytest; extra == 'dev'
@@ -48,13 +50,16 @@ Description-Content-Type: text/markdown
 
 <p align="center">
   <a href="docs/screenshot.png" target="blank"><img src="docs/screenshot.png" width="400" /></a>
+  <a href="docs/screenshot2.png" target="blank"><img src="docs/screenshot2.png" width="400" /></a>
 </p>
 
 ## 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 image rendering (some protocols in beta)
+- Supports for all Jupyter notebook versions, including old legacy formats.
 
 ## Motivation
 

nbcat-0.13.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+nbcat/__init__.py,sha256=Zg3oo58_HXe_ieb_PwWnYkKGH2zTvu6G2jly-7GnPGo,23
+nbcat/enums.py,sha256=Fn8PIcLl_uY4nQIs1EUvmKTwfhNUIZgmhRFiCSJk9wk,411
+nbcat/exceptions.py,sha256=Ho7LQz9K70VtIMDNtAwuAtGmb-lFKxGxSj7MN3-EpDA,321
+nbcat/image.py,sha256=hGZZK5mtij7ckWAvQwzim3thqGC92pLW5ZU5CYbRv_Q,995
+nbcat/main.py,sha256=pTOt0Kt7WJqf7H--JmXtvBgFJG-bBu6WsBG4KFl9wAE,6727
+nbcat/markdown.py,sha256=fbYBy36rR0SKqvNI6Yj75Xv2snwFRmhbCJIC1wCX2Hg,3055
+nbcat/pager.py,sha256=Yu0XIh5MvhvT-cmULYVxo6s2Ufjf2CQ-NDS5fcMQ-IM,3184
+nbcat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nbcat/schemas.py,sha256=a7GoKgPTHgun199-J-sZq-ahkdQwvyRaCdQVg1gC798,3135
+nbcat-0.13.1.dist-info/METADATA,sha256=qU0l9XpIN1Beqb3sI5-1s4UvHjSgHHTDFp05RAu9fZc,4443
+nbcat-0.13.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nbcat-0.13.1.dist-info/entry_points.txt,sha256=io_GRDsecAkYuCZALsjyea3VBq91VCoSznqlZEAJshY,42
+nbcat-0.13.1.dist-info/licenses/LICENSE,sha256=7GjUnahXdd5opdvlpJdb1BisLbiXt2iOFhzIUduhdkE,1072
+nbcat-0.13.1.dist-info/RECORD,,

nbcat-0.12.1.dist-info/RECORD

@@ -1,13 +0,0 @@
-nbcat/__init__.py,sha256=PAuBI8I6F9Yu_86XjI2yaWn8QmCd9ZvK7tkZLWvEg-Q,23
-nbcat/enums.py,sha256=Fn8PIcLl_uY4nQIs1EUvmKTwfhNUIZgmhRFiCSJk9wk,411
-nbcat/exceptions.py,sha256=Ho7LQz9K70VtIMDNtAwuAtGmb-lFKxGxSj7MN3-EpDA,321
-nbcat/image.py,sha256=hGZZK5mtij7ckWAvQwzim3thqGC92pLW5ZU5CYbRv_Q,995
-nbcat/main.py,sha256=gZ8mM2louxU8GgB40F7DE7pc7MAidDHatiNjkLUzeug,5839
-nbcat/markdown.py,sha256=GkPNfzBhNLMl89pVcj14U6ytYUVk3yNB0G1zGYRRJ04,2962
-nbcat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nbcat/schemas.py,sha256=a7GoKgPTHgun199-J-sZq-ahkdQwvyRaCdQVg1gC798,3135
-nbcat-0.12.1.dist-info/METADATA,sha256=Jq7TL6gCnqsAn_hm5eTHHK-DRGbp3nXn4aq6-w_jv2Y,4164
-nbcat-0.12.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nbcat-0.12.1.dist-info/entry_points.txt,sha256=io_GRDsecAkYuCZALsjyea3VBq91VCoSznqlZEAJshY,42
-nbcat-0.12.1.dist-info/licenses/LICENSE,sha256=7GjUnahXdd5opdvlpJdb1BisLbiXt2iOFhzIUduhdkE,1072
-nbcat-0.12.1.dist-info/RECORD,,