Skip to main content

Lightweight ipython/jupyter notebook diffing tool

Project description

A lightweight ipython/jupyter notebook diffing tool.

build-status-image

Purpose

This tool makes ipython/jupyter notebook diffs more readable.

This tool is meant for text-based diffing from the command-line.

Overview

Running ndb shows differences in the following types of data:

  • Python code
  • reStructuredText code
  • Resource files (e.g. PNGs)

This will show you most of what has changed in the In[1]: and Out[1]: lines of the notebook.

The output of ndb is git-diff output and can be piped to other commands like less(1) and tee(1).

Requirements

  • Python >= 2.6
  • nbconvert
  • pandoc
  • git

Install

Install with pip (or your favorite python package manager):

pip install nbd

Usage

Help:

nbd -h

Simple usage:

nbd <notebook>

Pipe to less(1):

nbd <notebook> | less

Options (see help for all):

nbd -e python <notebook>
nbd <notebook1> <notebook2> <notebook3>
nbd <notebook> --git-diff-option="--name-only"

Build and install from sources

Source distribution:

python setup.py sdist

After building, install with pip:

pip install dist/nbd-$version.tar.gz

Install in a virtual environment to avoid system pip issues.

Tutorial

See the tutorial in the demo/ directory: demo tutorial.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for nbd, version 0.2
Filename, size File type Python version Upload date Hashes
Filename, size nbd-0.2.tar.gz (10.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page