Skip to content

Tools for diffing and merging of Jupyter notebooks.

License

Notifications You must be signed in to change notification settings

saiwing-yeung/nbdime

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Sep 30, 2021
8f931cb · Sep 30, 2021
Sep 30, 2021
Jun 24, 2021
Dec 14, 2020
May 25, 2021
Sep 30, 2021
Dec 21, 2015
May 3, 2016
Apr 14, 2021
Nov 9, 2015
Feb 20, 2017
Apr 14, 2021
Mar 5, 2020
Apr 12, 2021
Jul 12, 2017
Mar 21, 2018
Apr 26, 2018
Sep 29, 2021
Apr 12, 2021
Dec 2, 2016
Jun 8, 2018
Apr 20, 2021
Jul 25, 2019
Oct 8, 2018
Oct 8, 2018

Repository files navigation

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

nbdime Jupyter Notebook Diff and Merge tools

Build Status codecov.io Documentation Status Google Group

nbdime provides tools for diffing and merging of Jupyter 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:

terminal-diff

Merging notebooks in a browser:

web-merge

Installation

Install nbdime with pip:

pip install nbdime

See the installation docs for more installation details and development installation instructions.

Documentation

See the latest documentation at https://nbdime.readthedocs.io.

See also description and discussion in the Jupyter Enhancement Proposal.

Contributing

If you would like to contribute to the project, please read our contributor documentation and the CONTRIBUTING.md.

Development Install

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

For a development install, enter on the command line:

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

See installation documentation for additional detail, particularly related to performing a dev install for working on the browser script code.

Testing

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 the codecov browser extension to view test coverage in the source browser on github.

See testing documentation for additional detail.

License

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

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

Getting help

We encourage you to ask questions on the mailing list.

Resources

About

Tools for diffing and merging of Jupyter notebooks.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 42.1%
  • TypeScript 38.1%
  • Jupyter Notebook 16.3%
  • CSS 2.4%
  • Other 1.1%