Skip to main content

Diff and merge of Jupyter Notebooks

Project description

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

Project details


Download files

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

Source Distribution

nbdime-4.0.0a1.tar.gz (9.4 MB view details)

Uploaded Source

Built Distribution

nbdime-4.0.0a1-py3-none-any.whl (5.9 MB view details)

Uploaded Python 3

File details

Details for the file nbdime-4.0.0a1.tar.gz.

File metadata

  • Download URL: nbdime-4.0.0a1.tar.gz
  • Upload date:
  • Size: 9.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.15

File hashes

Hashes for nbdime-4.0.0a1.tar.gz
Algorithm Hash digest
SHA256 a198da71bd08807f9777a243a7a23f5cc5683d0e6958e9a808af7da80e56d64c
MD5 fa94a9ccb19f485439e0779b3253c528
BLAKE2b-256 37ceb304bdbdf0268131595dc3db145339585a8b4ae8619fc89b64d81ad47862

See more details on using hashes here.

Provenance

File details

Details for the file nbdime-4.0.0a1-py3-none-any.whl.

File metadata

  • Download URL: nbdime-4.0.0a1-py3-none-any.whl
  • Upload date:
  • Size: 5.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.15

File hashes

Hashes for nbdime-4.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 6afc68731c93823df399fdc16ed7da59f2d618fb11e214c42ef01facb4da54c3
MD5 ceb448f94e08ecc817e21ebffd8ffee5
BLAKE2b-256 ff5cfbfb943abeb275bf6daf2346d1db447fbffc4bea8ec024852f90f827c350

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page