nbcat 0.9.5__py3-none-any.whl → 0.10.0__py3-none-any.whl

nbcat/__init__.py

@@ -1 +1 @@
-__version__ = "0.9.5"
+__version__ = "0.10.0"

nbcat/image.py

@@ -0,0 +1,28 @@
+import base64
+import shutil
+from io import BytesIO
+from platform import system
+
+from PIL import Image as PilImage
+from rich.console import Console, ConsoleOptions, RenderResult
+from rich.text import Text
+from timg import METHODS, Renderer
+
+
+class Image:
+    def __init__(self, image: str):
+        img = BytesIO(base64.b64decode(image.replace("\n", "")))
+        self.image = PilImage.open(img)
+
+    @property
+    def method_class(self):
+        # TODO: auto detect terminal to benefit from sixel protocol support
+        method = "a24h" if system() != "Windows" else "ascii"
+        return METHODS[method]["class"]
+
+    def __rich_console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
+        img = Renderer()
+        img.load_image(self.image)
+        img.resize(shutil.get_terminal_size()[0] - 1)
+        output = img.to_string(self.method_class)
+        yield Text.from_ansi(output)

nbcat/main.py

@@ -9,7 +9,6 @@ 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
@@ -23,6 +22,8 @@ from .exceptions import (
     NotebookNotFoundError,
     UnsupportedNotebookTypeError,
 )
+from .image import Image
+from .markdown import Markdown
 from .schemas import Cell, Notebook
 
 console = Console()
@@ -94,7 +95,7 @@ def render_cell(cell: Cell) -> list[tuple[Union[str, None], RenderableType]]:
         return Text(input)
 
     def _render_image(input: str) -> None:
-        return None
+        return Image(input)
 
     def _render_json(input: str) -> Pretty:
         return Pretty(input)

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/schemas.py

@@ -34,7 +34,7 @@ class DisplayDataOutput(BaseOutput):
     def output(self) -> Union[CellOutput, None]:
         data_type_map = {
             "text/html": OutputCellType.HTML,
-            "text/png": OutputCellType.IMAGE,
+            "image/png": OutputCellType.IMAGE,
             "text/plain": OutputCellType.PLAIN,
             "application/vnd.raw.v1+json": OutputCellType.JSON,
         }

{nbcat-0.9.5.dist-info → nbcat-0.10.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbcat
-Version: 0.9.5
+Version: 0.10.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: timg
 Provides-Extra: dev
 Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
@@ -41,10 +42,14 @@ Requires-Dist: pytest-responses; extra == 'dev'
 Requires-Dist: ruff; extra == 'dev'
 Description-Content-Type: text/markdown
 
-# 📦 nbcat
+# 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
@@ -87,7 +92,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:
 

nbcat-0.10.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+nbcat/__init__.py,sha256=v4zmKjsKOPZbp6BrWoz7iK4ST0sdZdUh9bQSJmluZ5o,23
+nbcat/enums.py,sha256=Fn8PIcLl_uY4nQIs1EUvmKTwfhNUIZgmhRFiCSJk9wk,411
+nbcat/exceptions.py,sha256=Ho7LQz9K70VtIMDNtAwuAtGmb-lFKxGxSj7MN3-EpDA,321
+nbcat/image.py,sha256=xv_IH2JMyzelUvLjVUbubfc8blmRuxqa-FcKXn25LSk,909
+nbcat/main.py,sha256=89qxlA6viuRP6_ugbf7zRE4clH4oX67-1t1EbpABUfA,5838
+nbcat/markdown.py,sha256=K6yL9rY3uTxMPsRIJnxqNHmCX2Qc-f3my8eiHxTLfic,1835
+nbcat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nbcat/schemas.py,sha256=a7GoKgPTHgun199-J-sZq-ahkdQwvyRaCdQVg1gC798,3135
+nbcat-0.10.0.dist-info/METADATA,sha256=jAKupKwXwBtwqMmTT96IE1LihLl3GUhrfLBd0dfTAxw,4103
+nbcat-0.10.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nbcat-0.10.0.dist-info/entry_points.txt,sha256=io_GRDsecAkYuCZALsjyea3VBq91VCoSznqlZEAJshY,42
+nbcat-0.10.0.dist-info/licenses/LICENSE,sha256=7GjUnahXdd5opdvlpJdb1BisLbiXt2iOFhzIUduhdkE,1072
+nbcat-0.10.0.dist-info/RECORD,,

nbcat-0.9.5.dist-info/RECORD

@@ -1,11 +0,0 @@
-nbcat/__init__.py,sha256=ORAtCCI2THBDcdzIbh6oBsoshDvkkmXUWpmO4Q5McAk,22
-nbcat/enums.py,sha256=Fn8PIcLl_uY4nQIs1EUvmKTwfhNUIZgmhRFiCSJk9wk,411
-nbcat/exceptions.py,sha256=Ho7LQz9K70VtIMDNtAwuAtGmb-lFKxGxSj7MN3-EpDA,321
-nbcat/main.py,sha256=H2gQgJYzf00DLOVp8v6yKbcKW3ZL3O9jb65VZEM7IZ0,5809
-nbcat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nbcat/schemas.py,sha256=fjSbdXa4pHKRV1Z-vUESkYZywkojanCvSu8s7rc9Xkw,3134
-nbcat-0.9.5.dist-info/METADATA,sha256=6X7lT_xc9vkN1HI6pCbxE9cIK7dqeIB6NJQ1ATuLJlU,3970
-nbcat-0.9.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nbcat-0.9.5.dist-info/entry_points.txt,sha256=io_GRDsecAkYuCZALsjyea3VBq91VCoSznqlZEAJshY,42
-nbcat-0.9.5.dist-info/licenses/LICENSE,sha256=7GjUnahXdd5opdvlpJdb1BisLbiXt2iOFhzIUduhdkE,1072
-nbcat-0.9.5.dist-info/RECORD,,