nbcat

Overview

display your notebooks, in the terminal

Installation

use pipx to install:

pipx install git+https://github.com/tsvikas/nbcat.git

Usage

nbcat FILENAME -R | less -R

use -f FORMAT to specify the output format, default is markdown

Development

• install git, uv.
• git clone this repo: git clone tsvikas/nbcat.git
• run uv run just prepare

Code quality

• use uv run just format to format the code.
• use uv run just lint to see linting errors.
• use uv run just test to see run tests.
• use uv run just check to run all the checks (format, lint, test, and pre-commit).
• Run a specific tool directly, with uv run pytest/ruff/mypy/black/...