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

Test 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.2.tar.gz (9.5 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file nbdime-4.0.2.tar.gz.

File metadata

  • Download URL: nbdime-4.0.2.tar.gz
  • Upload date:
  • Size: 9.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for nbdime-4.0.2.tar.gz
Algorithm Hash digest
SHA256 d8279f8f4b236c0b253b20d60c4831bb67843ed8dbd6e09f234eb011d36f1bf2
MD5 d1418e1abdc21b8eec36196647b8bdd7
BLAKE2b-256 a6f14be57ecea4d55d322f05a0f89e0b73d7a8d90a16dbf01168eab3e7bf5939

See more details on using hashes here.

File details

Details for the file nbdime-4.0.2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for nbdime-4.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e5a43aca669c576c66e757071c0e882de05ac305311d79aded99bfb5a3e9419e
MD5 ad7ae57d17018545a2759c9846405377
BLAKE2b-256 7323824b295f4cc53f4437f6917e8f46c519cd3a9be909dd36ca0682fdc7fff1

See more details on using hashes here.

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