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

nbcat/__init__.py

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

nbcat/image.py

@@ -1,31 +1,26 @@
-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
+from textual_image.renderable import Image
+from textual_image.renderable.halfcell import Image as HalfcellImage
+from textual_image.renderable.sixel import Image as SixelImage
+from textual_image.renderable.tgp import Image as TGPImage
+from textual_image.renderable.unicode import Image as UnicodeImage
 
 
-class Image:
-    def __init__(self, image: str, method: str = "a24h"):
-        img = BytesIO(base64.b64decode(image.replace("\n", "")))
-        self.image = PilImage.open(img)
-        self.method = method if system() != "Windows" else "ascii"
+def render_image(image_content: bytes) -> TGPImage | SixelImage | HalfcellImage | UnicodeImage:
+    """
+    Render an image from raw byte content and adjusts it to fit the terminal width.
 
-    def __rich_console__(self, console: Console, options: ConsoleOptions) -> RenderResult:
-        renderer = Renderer()
-        renderer.load_image(self.image)
-        width = shutil.get_terminal_size()[0] - 1
-        if self.method == "sixel":
-            width = width * 6
+    Args:
+        image_content (bytes): The raw byte content of the image.
 
-        renderer.resize(width)
-
-        if self.method == "sixel":
-            renderer.reduce_colors(16)
-
-        output = renderer.to_string(METHODS[self.method]["class"])
-        yield Text.from_ansi(output, no_wrap=True, end="")
+    Returns
+    -------
+        TGPImage | SixelImage | HalfcellImage | UnicodeImage: A terminal-compatible image
+        object adjusted to the current terminal width.
+    """
+    image = PilImage.open(BytesIO(image_content))
+    width = min(image.size[0], shutil.get_terminal_size()[0])
+    return Image(image, width=width, height="auto")

nbcat/main.py

@@ -1,4 +1,5 @@
 import argparse
+import base64
 import sys
 from pathlib import Path
 
@@ -14,6 +15,8 @@ from rich.pretty import Pretty
 from rich.syntax import Syntax
 from rich.text import Text
 
+from nbcat.image import render_image
+
 from . import __version__
 from .enums import CellType, OutputCellType
 from .exceptions import (
@@ -21,7 +24,6 @@ from .exceptions import (
     NotebookNotFoundError,
     UnsupportedNotebookTypeError,
 )
-from .image import Image
 from .markdown import Markdown
 from .pager import Pager
 from .schemas import Cell, Notebook
@@ -94,8 +96,8 @@ def render_cell(cell: Cell) -> RenderableType:
     def _render_raw(input: str) -> Text:
         return Text(input)
 
-    def _render_image(input: str) -> Image:
-        return Image(input)
+    def _render_image(input: str) -> RenderableType:
+        return render_image(base64.b64decode(input.replace("\n", "")))
 
     def _render_json(input: str) -> Pretty:
         return Pretty(input)

nbcat/markdown.py

@@ -10,7 +10,6 @@
 
 from __future__ import annotations
 
-import base64
 from pathlib import Path
 from typing import ClassVar
 
@@ -19,7 +18,7 @@ from rich import markdown as md
 from rich.console import Console, ConsoleOptions, RenderResult
 from rich.text import Text
 
-from .image import Image
+from .image import render_image
 
 
 class Heading(md.Heading):
@@ -53,9 +52,7 @@ class ImageItem(md.ImageItem):
                 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")
-            return Image(image).__rich_console__(console, options)
+            return render_image(image_content).__rich_console__(console, options)
         return super().__rich_console__(console, options)
 
 

{nbcat-0.13.1.dist-info → nbcat-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbcat
-Version: 0.13.1
+Version: 1.0.0
 Summary: cat for jupyter notebooks
 Project-URL: Homepage, https://github.com/akopdev/nbcat
 Project-URL: Repository, https://github.com/akopdev/nbcat
@@ -28,14 +28,14 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
 License-File: LICENSE
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Requires-Dist: argcomplete
 Requires-Dist: markdownify
 Requires-Dist: pydantic
 Requires-Dist: requests
 Requires-Dist: rich
 Requires-Dist: textual
-Requires-Dist: timg
+Requires-Dist: textual-image[textual]
 Provides-Extra: dev
 Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
@@ -44,9 +44,9 @@ Requires-Dist: pytest-responses; extra == 'dev'
 Requires-Dist: ruff; extra == 'dev'
 Description-Content-Type: text/markdown
 
-# nbcat
+<h1 align="center">nbcat: Jupyter notebooks viewer</h1>
 
-`nbcat` let you preview Jupyter notebooks directly in your terminal. Think of it as `cat`, but for `.ipynb` files.
+[nbcat](https://github.com/akopdev/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>
@@ -58,7 +58,7 @@ Description-Content-Type: text/markdown
 - 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 image rendering in high resolution
 - Supports for all Jupyter notebook versions, including old legacy formats.
 
 ## Motivation
@@ -74,12 +74,12 @@ Please note, that `nbcat` doesn't aim to replace JupyterLab. If you need a full-
 ## Installation
 
 ```bash
-# Install from PyPI
-pip install nbcat
+# Install from PyPI (recommended)
+$ pip install nbcat
 
 # Install via Homebrew
-brew tab akopdev/formulas/nbcat
-brew install nbcat
+$ brew tab akopdev/formulas/nbcat
+$ brew install nbcat
 ```
 
 ## Quickstart
@@ -93,13 +93,37 @@ You can pass URLs as well.
 ```bash
 $ nbcat https://raw.githubusercontent.com/akopdev/nbcat/refs/heads/main/tests/assets/test4.ipynb
 ```
+In most cases system `less` will render images in low resolution. Consider using an internal pager instead:
 
-Example use case with `fzf` command that lists all `.ipynb` files and uses `nbcat` for previewing them:
+```bash
+$ nbcat notebook.ipynb --page
+```
+## Integrations
+
+`nbcat` is designed to integrate seamlessly with other tools. Here are a few examples of how easily it can be done.
+
+### FZF (Fuzzy finder)
+
+List all `.ipynb` files and use `nbcat` to preview them:
 
 ```bash
 find . -type f -name "*.ipynb" | fzf --preview 'nbcat {}'
 ```
 
+### Ranger
+To enable previews in Ranger, add the `ipynb` extension to the `handle_extension` function in `~/.config/ranger/scope.sh`:
+
+```bash 
+...
+
+handle_extension() {
+    case "${FILE_EXTENSION_LOWER}" in
+        ipynb)
+            nbcat "${FILE_PATH}" && exit 5
+            exit 1;;
+        ...
+```
+
 ## Testing & Development
 
 Run the tests:

nbcat-1.0.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+nbcat/__init__.py,sha256=J-j-u0itpEFT6irdmWmixQqYMadNl1X91TxUmoiLHMI,22
+nbcat/enums.py,sha256=Fn8PIcLl_uY4nQIs1EUvmKTwfhNUIZgmhRFiCSJk9wk,411
+nbcat/exceptions.py,sha256=Ho7LQz9K70VtIMDNtAwuAtGmb-lFKxGxSj7MN3-EpDA,321
+nbcat/image.py,sha256=DSTdYpsVtsQTZj_TU9BZ0vrOmxqOoYfJoJsZ6EonIlM,982
+nbcat/main.py,sha256=8Vf-Cph_D35XT17HKvW8XfKmEosR1FVZIKHCtJj2JNw,6806
+nbcat/markdown.py,sha256=Onw9FsiW_OXAHBBg4Culf22RA4iM0cttGPyQvSzRD3g,2902
+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-1.0.0.dist-info/METADATA,sha256=TzEH94VbwxQLYfVnDXPWhjtHQn61DoClnc5zOJiIhoU,5122
+nbcat-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nbcat-1.0.0.dist-info/entry_points.txt,sha256=io_GRDsecAkYuCZALsjyea3VBq91VCoSznqlZEAJshY,42
+nbcat-1.0.0.dist-info/licenses/LICENSE,sha256=7GjUnahXdd5opdvlpJdb1BisLbiXt2iOFhzIUduhdkE,1072
+nbcat-1.0.0.dist-info/RECORD,,

nbcat-0.13.1.dist-info/RECORD

@@ -1,14 +0,0 @@
-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,,