Pretty Notebook package

Pretty Notebook is a Python library and command-line interface for interconnected Markdown notebooks. A notebook is an existing directory of Markdown files; a note is one source file. Wiki links, tags, code blocks and URLs have explicit models, while ordinary Markdown remains the authoritative content.

Choose a version

The 0.10 candidate is pretty-notebook==0.10.0rc2 on Python 3.11 or newer. It supplies canonical pretty_notebook imports, compatible pnbp imports, and the pnbp executable.

python -m pip uninstall pnbp
python -m pip install pretty-notebook==0.10.0rc2
pnbp --help

Uninstall the old distribution before installing the candidate to preserve the compatibility modules. See package migration and 0.10 release notes. The historical stable package is pnbp==0.9.0; its versioned release notes retain that contract.

For source development, install the checkout with python -m pip install --editable ..

First notebook and existing notebooks

Follow the notebook workflow tutorial for a temporary notebook, initialization, pending edits, checked renames, search and navigation. Its local examples are executed by the documentation build.

from pretty_notebook import Notebook

nb = Notebook.open("~/notes", settings={"NOTE_NESTED": "recurs"})
note = nb.get("guides/overview", fuzzy=False)

The path must already exist. Opening reads files without prompting or creating configuration. Initialize deliberately with pnbp init PATH; see the canonical settings and profile guide for precedence, migration and credentials. Notebook() continues to use NOTE_PATH for existing environment-based setups.

Continue by topic

• Note commands and pending edits: add/edit, empty bodies, saves and recovery drafts.
• Models and methods and generated API reference: public imports and signatures.
• Local search, navigation and links: read-only projections and explicit traversal.
• Stable identities and publication routes: identity, source paths and URLs remain separate.
• Checked publishing: dry-run plans, ETags, retries and explicit pruning.
• Web deployment: separate application, bootstrap, durable state and the supported local-host worker profile.

The macOS URL handlers are unsupported. The FastAPI app and its optional dependencies are absent from the pnbp wheel.