nbcat 0.9.0__tar.gz → 0.9.3__tar.gz

{nbcat-0.9.0 → nbcat-0.9.3}/.github/workflows/ci.yml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - main
+    tags:
+      - 'v*'  
   pull_request:
 
 jobs:
@@ -31,11 +33,12 @@ jobs:
           path: dist/
 
   deploy:
-    if: ${{ github.ref == 'refs/heads/main' && success() }}
+    if: ${{ startsWith(github.ref, 'refs/tags/') && success() }}
     needs: build
     runs-on: ubuntu-latest
     environment: pypi
     permissions:
+      contents: write
       id-token: write
     steps:
       - uses: actions/checkout@v4
@@ -52,5 +55,10 @@ jobs:
       - name: List contents
         run: ls -la dist/
 
-      - name: Publish
+      - name: Upload to PyPi
         uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Upload to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*

{nbcat-0.9.0 → nbcat-0.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbcat
-Version: 0.9.0
+Version: 0.9.3
 Summary: cat for jupyter notebooks
 Project-URL: Homepage, https://github.com/akopdev/nbcat
 Project-URL: Repository, https://github.com/akopdev/nbcat
@@ -43,48 +43,39 @@ Description-Content-Type: text/markdown
 
 # 📦 nbcat
 
-cat for jupyter notebooks
-
-[![License](https://img.shields.io/github/license/akopdev/nbcat)](./LICENSE)
-[![Build](https://github.com/akopdev/nbcat/actions/workflows/ci.yml/badge.svg)](https://github.com/akopdev/nbcat/actions)
-
----
+`nbcat` lets you preview Jupyter notebooks directly in your terminal. Think of it as `cat`, but for `.ipynb` files.
 
 ## 🚀 Features
 
-- ✅ Clean, minimal API
-- 🧰 Easily extensible
-- 🧪 Fully tested and type-annotated
-- ⚡ Fast and lightweight
-- 📦 Available on PyPI
-
----
+- Fast and lightweight with minimal external dependencies
+- Preview remote notebooks without downloading them
+- Supports for all Jupyter notebook versions - including legacy formats 
 
 ## 📦 Installation
 
-Install with [uv](https://github.com/astral-sh/uv)
+From the command line using pip:
 
 ```bash
-uv pip install nbcat
+pip install nbcat
 ```
 
-To install the latest development version:
+## 🛠️ Quickstart
 
 ```bash
-uv pip install git+https://github.com/akopdev/nbcat.git
+$ nbcat notebook.ipynb
 ```
 
----
-
-## 🛠️ Quickstart
+You can pass URLs as well.
 
-```python
-# example of using the package
+```bash
+$ nbcat https://raw.githubusercontent.com/akopdev/nbcat/refs/heads/main/tests/assets/test4.ipynb
 ```
 
-For more examples, check out the [`examples/`](./examples/) folder.
+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
 
@@ -97,29 +88,17 @@ make test
 Check code quality:
 
 ```bash
-make lint
-```
-
-Format code:
-
-```bash
-make format
+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_
@@ -128,4 +107,4 @@ Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more informati
 
 ---
 
-> Made with ❤️ by [Akop Kesheshyan](https://github.com/akopdev)
+Made with ❤️ by [Akop Kesheshyan](https://github.com/akopdev)

nbcat-0.9.3/README.md

@@ -0,0 +1,67 @@
+# 📦 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.0 → nbcat-0.9.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "nbcat"
-version = "0.9.0"
+version = "0.9.3"
 description = "cat for jupyter notebooks"
 authors = [
     { name = "Akop Kesheshyan", email = "devnull@akop.dev" }

nbcat-0.9.3/src/nbcat/__init__.py

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

{nbcat-0.9.0 → nbcat-0.9.3}/src/nbcat/main.py

@@ -26,7 +26,7 @@ from .schemas import Cell, Notebook
 console = Console()
 
 
-def read_notebook(fp: str) -> Notebook:
+def read_notebook(fp: str, debug: bool = False) -> Notebook:
     """
     Load and parse a Jupyter notebook from a local file or remote URL.
 
@@ -61,6 +61,8 @@ def read_notebook(fp: str) -> Notebook:
     try:
         return Notebook.model_validate_json(content)
     except ValidationError as e:
+        if not debug:
+            raise InvalidNotebookFormatError("Failed to read notebook")
         raise InvalidNotebookFormatError(f"Invalid notebook: {e}")
 
 
@@ -84,19 +86,16 @@ def render_cell(cell: Cell) -> list[tuple[str | None, RenderableType]]:
         return Markdown(input)
 
     def _render_code(input: str) -> Panel:
-        return Panel(Syntax(input, "python", line_numbers=True, theme="ansi_dark"), box=box.SQUARE)
+        return Panel(Syntax(input, "python", theme="ansi_dark"), box=box.SQUARE)
 
     def _render_raw(input: str) -> Text:
         return Text(input)
 
-    def _render_heading(input: str) -> Text:
-        return Text(input)
-
     RENDERERS = {
         CellType.MARKDOWN: _render_markdown,
         CellType.CODE: _render_code,
         CellType.RAW: _render_raw,
-        CellType.HEADING: _render_heading,
+        CellType.HEADING: _render_markdown,
     }
 
     rows: list[tuple[str | None, RenderableType]] = []
@@ -159,11 +158,14 @@ def main():
         action="version",
         version=__version__,
     )
+    parser.add_argument(
+        "--debug", help="enable extended error output", action="store_true", default=False
+    )
 
     try:
         argcomplete.autocomplete(parser)
         args = parser.parse_args()
-        notebook = read_notebook(args.file)
+        notebook = read_notebook(args.file, debug=args.debug)
         print_notebook(notebook)
     except Exception as e:
         sys.exit(f"nbcat: {e}")

{nbcat-0.9.0 → nbcat-0.9.3}/src/nbcat/schemas.py

@@ -70,7 +70,7 @@ class Cell(BaseModel):
     @property
     def input(self) -> str:
         if self.cell_type == CellType.HEADING and self.level is not None:
-            return f"{'#' * self.level} {self.source}"
+            return f"{'#' * self.level} {''.join(self.source)}"
 
         if isinstance(self.source, list):
             return "".join(self.source)
@@ -87,7 +87,7 @@ class Notebook(BaseModel):
     def handle_format_versions(cls, data: dict[str, Any]) -> dict[str, Any]:
         if data.get("worksheets"):
             try:
-                data["cells"] = data.get("worksheets")[0].get("cells", [])
+                data["cells"] = data.get("worksheets", [{"cells": []}])[0].get("cells", [])
             except (KeyError, IndexError, TypeError) as e:
                 print(e)
                 raise InvalidNotebookFormatError(f"Invalid v3 notebook structure: {e}")

{nbcat-0.9.0 → nbcat-0.9.3}/tests/test_render_cell.py

@@ -13,7 +13,7 @@ from nbcat.schemas import Cell, StreamOutput
         ("markdown", "# Heading", Markdown),
         ("code", "print('Hello')", Panel),
         ("raw", "Raw content", Text),
-        ("heading", "Heading text", Text),
+        ("heading", "Heading text", Markdown),
     ],
 )
 def test_render_cell_input_rendering(cell_type: str, source: str, expected):

{nbcat-0.9.0 → nbcat-0.9.3}/uv.lock

@@ -214,7 +214,7 @@ wheels = [
 
 [[package]]
 name = "nbcat"
-version = "0.9.0"
+version = "0.9.3"
 source = { editable = "." }
 dependencies = [
     { name = "argcomplete" },

nbcat-0.9.0/README.md

@@ -1,88 +0,0 @@
-# 📦 nbcat
-
-cat for jupyter notebooks
-
-[![License](https://img.shields.io/github/license/akopdev/nbcat)](./LICENSE)
-[![Build](https://github.com/akopdev/nbcat/actions/workflows/ci.yml/badge.svg)](https://github.com/akopdev/nbcat/actions)
-
----
-
-## 🚀 Features
-
-- ✅ Clean, minimal API
-- 🧰 Easily extensible
-- 🧪 Fully tested and type-annotated
-- ⚡ Fast and lightweight
-- 📦 Available on PyPI
-
----
-
-## 📦 Installation
-
-Install with [uv](https://github.com/astral-sh/uv)
-
-```bash
-uv pip install nbcat
-```
-
-To install the latest development version:
-
-```bash
-uv pip install git+https://github.com/akopdev/nbcat.git
-```
-
----
-
-## 🛠️ Quickstart
-
-```python
-# example of using the package
-```
-
-For more examples, check out the [`examples/`](./examples/) folder.
-
----
-
-## 🧪 Testing & Development
-
-Run the tests:
-
-```bash
-make test
-```
-
-Check code quality:
-
-```bash
-make lint
-```
-
-Format code:
-
-```bash
-make format
-```
-
----
-
-## 🙌 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.0/src/nbcat/__init__.py

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