nbcat

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
• run uv run just prepare

Code formatting

• use uv run black . to format code
• use git ls-files -z -- '*.md' '*.rst' '*.tex' '*.py' | xargs -0 uv run blacken-docs to format docs

Code quality

• use uv run ruff check . to verify code quality
• use uv run mypy to verify check typing
• use uv run pytest to run tests

Build

• run formatting, linting, and tests.
• use uv run dunamai from git to see the current version
• use git tag -a vX.Y.Z -m "version vX.Y.Z" -e to add a git tag
• use uv build to build
• push the tag with git push origin tag vX.Y.Z