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

nbcat/__init__.py

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

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

@@ -1,6 +1,7 @@
 import argparse
 import sys
 from pathlib import Path
+from typing import Union
 
 import argcomplete
 import requests
@@ -10,12 +11,13 @@ 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,
@@ -66,7 +68,7 @@ def read_notebook(fp: str, debug: bool = False) -> Notebook:
         raise InvalidNotebookFormatError(f"Invalid notebook: {e}")
 
 
-def render_cell(cell: Cell) -> list[tuple[str | None, RenderableType]]:
+def render_cell(cell: Cell) -> list[tuple[Union[str, None], RenderableType]]:
     """
     Render the content of a notebook cell for display.
 
@@ -91,18 +93,28 @@ def render_cell(cell: Cell) -> list[tuple[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[str | None, RenderableType]] = []
+    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,
@@ -112,13 +124,16 @@ def render_cell(cell: Cell) -> list[tuple[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/schemas.py

@@ -1,25 +1,29 @@
-from typing import Any
+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
 
 
 class BaseOutput(BaseModel):
     output_type: OutputType
-    execution_count: int | None = None
+    execution_count: Union[int, None] = None
+
+
+class CellOutput(BaseModel):
+    output_type: OutputCellType
+    text: str
 
 
 class StreamOutput(BaseOutput):
-    text: list[str] | str
+    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,16 +61,16 @@ 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):
     cell_type: CellType
-    source: list[str] | str
-    level: int | None = None
-    execution_count: int | None = None
-    outputs: list[StreamOutput | DisplayDataOutput | ErrorOutput | PyoutDataOutput] = []
+    source: Union[list[str], str]
+    level: Union[int, None] = None
+    execution_count: Union[int, None] = None
+    outputs: list[Union[StreamOutput, DisplayDataOutput, ErrorOutput, PyoutDataOutput]] = []
 
     @model_validator(mode="before")
     @classmethod

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbcat
-Version: 0.9.3
+Version: 0.9.5
 Summary: cat for jupyter notebooks
 Project-URL: Homepage, https://github.com/akopdev/nbcat
 Project-URL: Repository, https://github.com/akopdev/nbcat
@@ -28,7 +28,7 @@ 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.10
+Requires-Python: >=3.9
 Requires-Dist: argcomplete
 Requires-Dist: pydantic
 Requires-Dist: requests
@@ -43,15 +43,25 @@ Description-Content-Type: text/markdown
 
 # 📦 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
+## Features
 
-- Fast and lightweight with minimal external dependencies
+- 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
 
-## 📦 Installation
+## 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:
 
@@ -59,7 +69,7 @@ From the command line using pip:
 pip install nbcat
 ```
 
-## 🛠️ Quickstart
+## Quickstart
 
 ```bash
 $ nbcat notebook.ipynb
@@ -91,15 +101,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.5.dist-info/RECORD

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

nbcat-0.9.3.dist-info/RECORD

@@ -1,11 +0,0 @@
-nbcat/__init__.py,sha256=xKd3pzbczuMsdB08eLAOqZDUd_q1IRxwZ_ccAFL4c4A,22
-nbcat/enums.py,sha256=ZsuOwYLF0D4PVwSkS74LwoXY0y0DkeBToLBWnmiS97Y,300
-nbcat/exceptions.py,sha256=Ho7LQz9K70VtIMDNtAwuAtGmb-lFKxGxSj7MN3-EpDA,321
-nbcat/main.py,sha256=X1UbLxXF9Y9V4Z8vE_pUz5cG22zx2oBMMlvpJVWITD0,5236
-nbcat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-nbcat/schemas.py,sha256=IK1l2a4UcP6Ivh8xRBzV5BIQTbeES1b1cCH-6goEq8Q,2366
-nbcat-0.9.3.dist-info/METADATA,sha256=IQV8OPxQ0sQFu1BdLK9g6z5-nSv4j36rUhaMJYv0FQ0,3376
-nbcat-0.9.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nbcat-0.9.3.dist-info/entry_points.txt,sha256=io_GRDsecAkYuCZALsjyea3VBq91VCoSznqlZEAJshY,42
-nbcat-0.9.3.dist-info/licenses/LICENSE,sha256=7GjUnahXdd5opdvlpJdb1BisLbiXt2iOFhzIUduhdkE,1072
-nbcat-0.9.3.dist-info/RECORD,,