nbcat 0.13.1__tar.gz → 1.0.0__tar.gz

{nbcat-0.13.1 → nbcat-1.0.0}/.github/workflows/ci.yml

@@ -62,3 +62,23 @@ jobs:
         uses: softprops/action-gh-release@v2
         with:
           files: dist/*
+
+  homebrew:
+    needs: deploy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Release project to Homebrew tap
+        uses: Justintime50/homebrew-releaser@v2
+        with:
+          homebrew_owner: akopdev
+          homebrew_tap: homebrew-formulas
+          github_token: ${{ secrets.HOMEBREW_TAP_TOKEN }}
+          install: 'virtualenv_install_with_resources'
+          test: 'assert_match version.to_s, shell_output("#{bin}/nbcat --version")'
+          commit_owner: akopdev
+          commit_email: devnull@akop.dev
+          update_readme_table: true
+          formula_includes: 'include Language::Python::Virtualenv'
+          depends_on: |
+            "python@3.13"
+            "pillow"

{nbcat-0.13.1 → nbcat-1.0.0}/PKG-INFO

@@ -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-0.13.1 → nbcat-1.0.0}/README.md

@@ -1,6 +1,6 @@
-# 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>
@@ -12,7 +12,7 @@
 - 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
@@ -28,12 +28,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
@@ -47,13 +47,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-0.13.1 → nbcat-1.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nbcat"
-version = "0.13.1"
+version = "1.0.0"
 description = "cat for jupyter notebooks"
 authors = [
     { name = "Akop Kesheshyan", email = "devnull@akop.dev" }
@@ -10,15 +10,15 @@ maintainers = [
 ]
 license = {file = "LICENSE"}
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 dependencies = [
     "argcomplete",
-    "requests",
+    "markdownify",
     "pydantic",
+    "requests",
     "rich",
-    "timg",
     "textual",
-    "markdownify"
+    "textual-image[textual]",
 ]
 
 [project.optional-dependencies]

nbcat-1.0.0/src/nbcat/__init__.py

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

nbcat-1.0.0/src/nbcat/image.py

@@ -0,0 +1,26 @@
+import shutil
+from io import BytesIO
+
+from PIL import Image as PilImage
+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
+
+
+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.
+
+    Args:
+        image_content (bytes): The raw byte content of the image.
+
+    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-0.13.1 → nbcat-1.0.0}/src/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-0.13.1 → nbcat-1.0.0}/src/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)