Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Lightweight ipython/jupyter notebook diffing tool

Project Description
nbd
===

A lightweight ipython/jupyter notebook diffing tool.

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 <https://git-scm.com/docs/git-diff>`__ output and can be piped
to other commands like `less(1) <https://linux.die.net/man/1/less>`__
and `tee(1) <https://linux.die.net/man/1/tee>`__.

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) <https://linux.die.net/man/1/less>`__:

::

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 <demo/tutorial.rst>`__.

.. raw:: html

<!-- links: -->
Release History

Release History

This version
History Node

0.1.dev5

History Node

0.1.dev4

History Node

0.1.dev3

History Node

0.1.dev2

History Node

0.0.1.dev1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
nbd-0.1.dev5.tar.gz (7.5 kB) Copy SHA256 Checksum SHA256 Source Sep 29, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting