Repository files navigation

Installation |Documentation |Contributing |Development Install |Testing |License |Getting help

nbdime provides tools for diffing and merging ofJupyter Notebooks.

• nbdiff compare notebooks in a terminal-friendly way
• nbmerge three-way merge of notebooks with automatic conflict resolution
• nbdiff-web shows you a rich rendered diff of notebooks
• nbmerge-web gives you a web-based three-way merge tool for notebooks
• nbshow present a single notebook in a terminal-friendly way

Diffing notebooks in the terminal:

Merging notebooks in a browser:

Install nbdime with pip:

pip install nbdime

Seethe installation docs for more installation details and development installation instructions.

See the latest documentation athttps://nbdime.readthedocs.io.

See also description and discussion in theJupyter Enhancement Proposal.

If you would like to contribute to the project, please read ourcontributor documentation and theCONTRIBUTING.md.

To install a development version of nbdime, you will neednpm installed and available on your PATH while installing.

For adevelopment install, enter on the command line:

pip install -e git+https://github.com/jupyter/nbdime#egg=nbdime

Seeinstallation documentation for additional detail, particularly related to performinga dev install for working on the browser script code.

Install the test requirements:

pip install nbdime[test]

To run Python tests locally, enter on the command line:pytest

To run Javascript tests locally, enter:npm test

Install thecodecov browser extension to view test coverage in the source browser on github.

Seetesting documentation for additional detail.

We use a shared copyright model that enables all contributors to maintain thecopyright on their contributions.

All code is licensed under the terms of the revised BSD license.

We encourage you to ask questions on themailing list.

• Reporting Issues

• Documentation for nbdime |PDF (latest)

• Documentation for Project Jupyter |PDF

• Project Jupyter website