https://github.com/lcary/nbd

A lightweight ipython/jupyter notebook diffing tool
https://github.com/lcary/nbd

diff diffing git-diff git-difftool ipython-notebook jupyter jupyter-notebook

Last synced: about 2 months ago
JSON representation

A lightweight ipython/jupyter notebook diffing tool

• Host: GitHub
• URL: https://github.com/lcary/nbd
• Owner: lcary
• License: mit
• Archived: true
• Created: 2017-09-28T07:31:01.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-08-23T17:04:24.000Z (about 2 years ago)
• Last Synced: 2024-09-24T22:05:05.813Z (about 2 months ago)
• Topics: diff, diffing, git-diff, git-difftool, ipython-notebook, jupyter, jupyter-notebook
• Language: Python
• Homepage:
• Size: 217 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
nbd

===

A lightweight ipython/jupyter notebook diffing tool.

.. image:: https://travis-ci.org/lcary/nbd.svg?branch=master

    :alt: build-status-image

    :target: https://travis-ci.org/lcary/nbd

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 

Pipe to `less(1) `_:

::

    nbd  | less

Options (see help for all):

::

    nbd -e python 

    nbd   

    nbd  --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 `_.