Installation

Quick look

Want to just see how nbpreview would render an output on your terminal? Use uv to get a preview. The snippet below installs uv (if not already in your system) and uses it to render a notebook stored in this repository.

% curl -LsSf https://astral.sh/uv/install.sh | sh
% curl https://raw.githubusercontent.com/paw-lu/nbpreview/refs/heads/main/docs/example_notebook_cells/hero_notebook.ipynb | uvx nbpreview

Installation

nbpreview can be installed through any of the major python package managers (eg uv, pipx, or pip from PyPI).

uv is the easiest way to get started, there are multiple ways to install it. (Such as the example snippet above using curl).

% uv tool install nbpreview

nbpreview may also be installed via pip if you prefer:

% python -m pip install nbpreview