nbcat 0.9.4__tar.gz → 0.9.6__tar.gz

{nbcat-0.9.4 → nbcat-0.9.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbcat
-Version: 0.9.4
+Version: 0.9.6
 Summary: cat for jupyter notebooks
 Project-URL: Homepage, https://github.com/akopdev/nbcat
 Project-URL: Repository, https://github.com/akopdev/nbcat
@@ -41,17 +41,31 @@ Requires-Dist: pytest-responses; extra == 'dev'
 Requires-Dist: ruff; extra == 'dev'
 Description-Content-Type: text/markdown
 
-# 📦 nbcat
+# nbcat
 
-`nbcat` lets you preview Jupyter notebooks directly in your terminal. Think of it as `cat`, but for `.ipynb` files.
+`nbcat` let you preview Jupyter notebooks directly in your terminal. Think of it as `cat`, but for `.ipynb` files.
 
-## 🚀 Features
+<p align="center">
+  <a href="docs/screenshot.png" target="blank"><img src="docs/screenshot.png" width="400" /></a>
+</p>
 
-- Fast and lightweight with minimal external dependencies
+## Features
+
+- Very fast and lightweight with minimal dependencies
 - Preview remote notebooks without downloading them
-- Supports for all Jupyter notebook versions - including legacy formats 
+- Supports for all Jupyter notebook versions, including old legacy formats
+
+## Motivation
+
+The idea of previewing notebooks in a terminal is not new - there have been many previous attempts to achieve it.  
+However, most are either slow and overengineered with a ton of half-working features, or they're outdated and incompatible with modern Python.
+
+I was looking for a simple tool that let me quickly render Jupyter notebooks without switching context from my terminal window or installing a ton of dependencies.  
+
+Please note, that `nbcat` doesn't aim to replace JupyterLab. If you need a full-featured terminal experience, I recommend checking out [euporie](https://euporie.readthedocs.io/) instead.
+
 
-## 📦 Installation
+## Installation
 
 From the command line using pip:
 
@@ -59,7 +73,7 @@ From the command line using pip:
 pip install nbcat
 ```
 
-## 🛠️ Quickstart
+## Quickstart
 
 ```bash
 $ nbcat notebook.ipynb
@@ -77,7 +91,7 @@ Example use case with `fzf` command that lists all `.ipynb` files and uses `nbca
 find . -type f -name "*.ipynb" | fzf --preview 'nbcat {}'
 ```
 
-## 🧪 Testing & Development
+## Testing & Development
 
 Run the tests:
 
@@ -91,15 +105,15 @@ Check code quality:
 make format lint
 ```
 
-## 🙌 Contributing
+## Contributing
 
 Contributions are welcome! Please open an issue or [pull request](https://github.com/akopdev/nbcat/pulls).
 
-## 📄 License
+## License
 
 Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.
 
-## 🔗 Useful Links
+## Useful Links
 
 - 📘 Documentation: _coming soon_
 - 🐛 Issues: [GitHub Issues](https://github.com/akopdev/nbcat/issues)

nbcat-0.9.6/README.md

@@ -0,0 +1,81 @@
+# nbcat
+
+`nbcat` let you preview Jupyter notebooks directly in your terminal. Think of it as `cat`, but for `.ipynb` files.
+
+<p align="center">
+  <a href="docs/screenshot.png" target="blank"><img src="docs/screenshot.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
+
+## Motivation
+
+The idea of previewing notebooks in a terminal is not new - there have been many previous attempts to achieve it.  
+However, most are either slow and overengineered with a ton of half-working features, or they're outdated and incompatible with modern Python.
+
+I was looking for a simple tool that let me quickly render Jupyter notebooks without switching context from my terminal window or installing a ton of dependencies.  
+
+Please note, that `nbcat` doesn't aim to replace JupyterLab. If you need a full-featured terminal experience, I recommend checking out [euporie](https://euporie.readthedocs.io/) instead.
+
+
+## Installation
+
+From the command line using pip:
+
+```bash
+pip install nbcat
+```
+
+## Quickstart
+
+```bash
+$ nbcat notebook.ipynb
+```
+
+You can pass URLs as well.
+
+```bash
+$ nbcat https://raw.githubusercontent.com/akopdev/nbcat/refs/heads/main/tests/assets/test4.ipynb
+```
+
+Example use case with `fzf` command that lists all `.ipynb` files and uses `nbcat` for previewing them:
+
+```bash
+find . -type f -name "*.ipynb" | fzf --preview 'nbcat {}'
+```
+
+## Testing & Development
+
+Run the tests:
+
+```bash
+make test
+```
+
+Check code quality:
+
+```bash
+make format lint
+```
+
+## Contributing
+
+Contributions are welcome! Please open an issue or [pull request](https://github.com/akopdev/nbcat/pulls).
+
+## License
+
+Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.
+
+## Useful Links
+
+- 📘 Documentation: _coming soon_
+- 🐛 Issues: [GitHub Issues](https://github.com/akopdev/nbcat/issues)
+- 🚀 Releases: [GitHub Releases](https://github.com/akopdev/nbcat/releases)
+
+---
+
+Made with ❤️ by [Akop Kesheshyan](https://github.com/akopdev)

{nbcat-0.9.4 → nbcat-0.9.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nbcat"
-version = "0.9.4"
+version = "0.9.6"
 description = "cat for jupyter notebooks"
 authors = [
     { name = "Akop Kesheshyan", email = "devnull@akop.dev" }
@@ -38,7 +38,6 @@ nbcat = "nbcat.main:main"
 mock_use_standalone_module = true
 
 [tool.pytest.ini_options]
-asyncio_default_fixture_loop_scope = "function"
 testpaths = "tests/"
 
 [tool.ruff]

nbcat-0.9.6/src/nbcat/__init__.py

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

{nbcat-0.9.4 → nbcat-0.9.6}/src/nbcat/enums.py

@@ -14,3 +14,10 @@ class OutputType(str, Enum):
     EXECUTE_RESULT = "execute_result"
     ERROR = "error"
     PYOUT = "pyout"
+
+
+class OutputCellType(str, Enum):
+    PLAIN = "plain"
+    HTML = "html"
+    IMAGE = "image"
+    JSON = "json"

{nbcat-0.9.4 → nbcat-0.9.6}/src/nbcat/main.py

@@ -9,19 +9,20 @@ from argcomplete.completers import FilesCompleter
 from pydantic import ValidationError
 from rich import box
 from rich.console import Console, RenderableType
-from rich.markdown import Markdown
 from rich.panel import Panel
+from rich.pretty import Pretty
 from rich.syntax import Syntax
 from rich.table import Table
 from rich.text import Text
 
 from . import __version__
-from .enums import CellType
+from .enums import CellType, OutputCellType
 from .exceptions import (
     InvalidNotebookFormatError,
     NotebookNotFoundError,
     UnsupportedNotebookTypeError,
 )
+from .markdown import Markdown
 from .schemas import Cell, Notebook
 
 console = Console()
@@ -92,18 +93,28 @@ def render_cell(cell: Cell) -> list[tuple[Union[str, None], RenderableType]]:
     def _render_raw(input: str) -> Text:
         return Text(input)
 
+    def _render_image(input: str) -> None:
+        return None
+
+    def _render_json(input: str) -> Pretty:
+        return Pretty(input)
+
     RENDERERS = {
         CellType.MARKDOWN: _render_markdown,
         CellType.CODE: _render_code,
         CellType.RAW: _render_raw,
         CellType.HEADING: _render_markdown,
+        OutputCellType.PLAIN: _render_raw,
+        OutputCellType.HTML: _render_markdown,
+        OutputCellType.IMAGE: _render_image,
+        OutputCellType.JSON: _render_json,
     }
 
     rows: list[tuple[Union[str, None], RenderableType]] = []
     renderer = RENDERERS.get(cell.cell_type)
     source = renderer(cell.input) if renderer else None
     if source:
-        label = f"[green][{cell.execution_count}][/]:" if cell.execution_count else None
+        label = f"[green][{cell.execution_count}][/]" if cell.execution_count else None
         rows.append(
             (
                 label,
@@ -113,13 +124,16 @@ def render_cell(cell: Cell) -> list[tuple[Union[str, None], RenderableType]]:
 
     for o in cell.outputs:
         if o.output:
-            label = f"[blue][{o.execution_count}][/]:" if o.execution_count else None
-            rows.append(
-                (
-                    label,
-                    o.output,
+            renderer = RENDERERS.get(o.output.output_type)
+            output = renderer(o.output.text) if renderer else None
+            if output:
+                label = f"[blue][{o.execution_count}][/]" if o.execution_count else None
+                rows.append(
+                    (
+                        label,
+                        output,
+                    )
                 )
-            )
     return rows
 
 

nbcat-0.9.6/src/nbcat/markdown.py

@@ -0,0 +1,51 @@
+# In an ideal world, this code shouldn't exist. However, for reasons unknown to me,
+# `rich` decided to format markdown headers in a way that makes them unusable
+# in the terminal: they are centered and wrapped in a Panel, which causes them to
+# blend in with the rest of the content. It takes me time to understand what I'm
+# looking at.
+#
+# Instead, I override the default implementation by adding colors and preserving
+# the original formatting, so that the headers remain recognizable even on
+# black-and-white screens.
+
+from __future__ import annotations
+
+from typing import ClassVar
+
+from rich import markdown as md
+from rich.console import Console, ConsoleOptions, RenderResult
+from rich.text import Text
+
+
+class Heading(md.Heading):
+    """A heading."""
+
+    def __rich_console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
+        styles = {
+            "h1": "bold cyan",
+            "h2": "bold magenta",
+            "h3": "bold yellow",
+        }
+        indent = int(self.tag.strip("h"))
+        yield Text(f"{'#' * indent} {self.text}", style=styles.get(self.tag, "dim white"))
+
+
+class Markdown(md.Markdown):
+    elements: ClassVar[dict[str, type[md.MarkdownElement]]] = {
+        "paragraph_open": md.Paragraph,
+        "heading_open": Heading,
+        "fence": md.CodeBlock,
+        "code_block": md.CodeBlock,
+        "blockquote_open": md.BlockQuote,
+        "hr": md.HorizontalRule,
+        "bullet_list_open": md.ListElement,
+        "ordered_list_open": md.ListElement,
+        "list_item_open": md.ListItem,
+        "image": md.ImageItem,
+        "table_open": md.TableElement,
+        "tbody_open": md.TableBodyElement,
+        "thead_open": md.TableHeaderElement,
+        "tr_open": md.TableRowElement,
+        "td_open": md.TableDataElement,
+        "th_open": md.TableDataElement,
+    }

{nbcat-0.9.4 → nbcat-0.9.6}/src/nbcat/schemas.py

@@ -2,7 +2,7 @@ from typing import Any, Union
 
 from pydantic import BaseModel, computed_field, model_validator
 
-from .enums import CellType, OutputType
+from .enums import CellType, OutputCellType, OutputType
 from .exceptions import InvalidNotebookFormatError
 
 
@@ -11,15 +11,19 @@ class BaseOutput(BaseModel):
     execution_count: Union[int, None] = None
 
 
+class CellOutput(BaseModel):
+    output_type: OutputCellType
+    text: str
+
+
 class StreamOutput(BaseOutput):
     text: Union[list[str], str]
 
     @computed_field
     @property
-    def output(self) -> str:
-        if isinstance(self.text, list):
-            return "".join(self.text)
-        return self.text
+    def output(self) -> CellOutput:
+        text = "".join(self.text) if isinstance(self.text, list) else self.text
+        return CellOutput(output_type=OutputCellType.PLAIN, text=text)
 
 
 class DisplayDataOutput(BaseOutput):
@@ -27,9 +31,18 @@ class DisplayDataOutput(BaseOutput):
 
     @computed_field
     @property
-    def output(self) -> str:
-        # TODO: add support for rich display outputs
-        return ""
+    def output(self) -> Union[CellOutput, None]:
+        data_type_map = {
+            "text/html": OutputCellType.HTML,
+            "text/png": OutputCellType.IMAGE,
+            "text/plain": OutputCellType.PLAIN,
+            "application/vnd.raw.v1+json": OutputCellType.JSON,
+        }
+        for data_type, output_type in data_type_map.items():
+            data = self.data.get(data_type)
+            if data:
+                text = "".join(data) if isinstance(data, list) else str(data)
+                return CellOutput(output_type=output_type, text=text)
 
 
 class ErrorOutput(BaseOutput):
@@ -39,8 +52,8 @@ class ErrorOutput(BaseOutput):
 
     @computed_field
     @property
-    def output(self) -> str:
-        return "\n".join(self.traceback)
+    def output(self) -> CellOutput:
+        return CellOutput(output_type=OutputCellType.PLAIN, text="\n".join(self.traceback))
 
 
 class PyoutDataOutput(BaseOutput):
@@ -48,8 +61,8 @@ class PyoutDataOutput(BaseOutput):
 
     @computed_field
     @property
-    def output(self) -> str:
-        return "\n".join(self.text)
+    def output(self) -> CellOutput:
+        return CellOutput(output_type=OutputCellType.PLAIN, text="\n".join(self.text))
 
 
 class Cell(BaseModel):

{nbcat-0.9.4 → nbcat-0.9.6}/tests/test_render_cell.py

@@ -22,7 +22,7 @@ def test_render_cell_input_rendering(cell_type: str, source: str, expected):
 
     assert len(rendered) == 1
     label, content = rendered[0]
-    assert label == "[green][42][/]:"
+    assert label == "[green][42][/]"
     assert isinstance(content, expected)
 
 
@@ -44,11 +44,11 @@ def test_render_cell_with_outputs():
     assert rendered[0][0] is None
     assert isinstance(rendered[0][1], Panel)
 
-    assert rendered[1][0] == "[blue][7][/]:"
-    assert isinstance(rendered[1][1], str)
+    assert rendered[1][0] == "[blue][7][/]"
+    assert isinstance(rendered[1][1], Text)
 
     assert rendered[2][0] is None
-    assert isinstance(rendered[2][1], str)
+    assert isinstance(rendered[2][1], Text)
 
 
 def test_render_cell_skips_empty_outputs():
@@ -63,5 +63,5 @@ def test_render_cell_skips_empty_outputs():
     rendered = render_cell(cell)
 
     assert len(rendered) == 1  # Only source input is rendered
-    assert rendered[0][0] == "[green][1][/]:"
+    assert rendered[0][0] == "[green][1][/]"
     assert isinstance(rendered[0][1], Text)

{nbcat-0.9.4 → nbcat-0.9.6}/uv.lock

@@ -237,7 +237,7 @@ wheels = [
 
 [[package]]
 name = "nbcat"
-version = "0.9.4"
+version = "0.9.6"
 source = { editable = "." }
 dependencies = [
     { name = "argcomplete" },

nbcat-0.9.4/README.md

@@ -1,67 +0,0 @@
-# 📦 nbcat
-
-`nbcat` lets you preview Jupyter notebooks directly in your terminal. Think of it as `cat`, but for `.ipynb` files.
-
-## 🚀 Features
-
-- Fast and lightweight with minimal external dependencies
-- Preview remote notebooks without downloading them
-- Supports for all Jupyter notebook versions - including legacy formats 
-
-## 📦 Installation
-
-From the command line using pip:
-
-```bash
-pip install nbcat
-```
-
-## 🛠️ Quickstart
-
-```bash
-$ nbcat notebook.ipynb
-```
-
-You can pass URLs as well.
-
-```bash
-$ nbcat https://raw.githubusercontent.com/akopdev/nbcat/refs/heads/main/tests/assets/test4.ipynb
-```
-
-Example use case with `fzf` command that lists all `.ipynb` files and uses `nbcat` for previewing them:
-
-```bash
-find . -type f -name "*.ipynb" | fzf --preview 'nbcat {}'
-```
-
-## 🧪 Testing & Development
-
-Run the tests:
-
-```bash
-make test
-```
-
-Check code quality:
-
-```bash
-make format lint
-```
-
-## 🙌 Contributing
-
-Contributions are welcome! Please open an issue or [pull request](https://github.com/akopdev/nbcat/pulls).
-
-## 📄 License
-
-Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.
-
-## 🔗 Useful Links
-
-- 📘 Documentation: _coming soon_
-- 🐛 Issues: [GitHub Issues](https://github.com/akopdev/nbcat/issues)
-- 🚀 Releases: [GitHub Releases](https://github.com/akopdev/nbcat/releases)
-
----
-
-Made with ❤️ by [Akop Kesheshyan](https://github.com/akopdev)

nbcat-0.9.4/src/nbcat/__init__.py

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