Diff and merge of Jupyter Notebooks

Navigation

Verified details

These details have been verified by PyPI
Project links
Owner
organization icon Project Jupyter
GitHub Statistics
Maintainers
Avatar for bgranger from gravatar.com bgranger Avatar for fperez from gravatar.com fperez Avatar for mbussonn from gravatar.com mbussonn Avatar for minrk from gravatar.com minrk Avatar for takowl from gravatar.com takowl Avatar for vidartf from gravatar.com vidartf

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (# Licensing terms This project is licensed under the terms of the Modified BSD License (also known ...)
  • Author: Jupyter Development Team
  • Tags Interactive, Interpreter, Shell, Web
  • Requires: Python >=3.6
  • Provides-Extra: docs, test
Classifiers

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

Verified details

These details have been verified by PyPI
Project links
Owner
organization icon Project Jupyter
GitHub Statistics
Maintainers
Avatar for bgranger from gravatar.com bgranger Avatar for fperez from gravatar.com fperez Avatar for mbussonn from gravatar.com mbussonn Avatar for minrk from gravatar.com minrk Avatar for takowl from gravatar.com takowl Avatar for vidartf from gravatar.com vidartf

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (# Licensing terms This project is licensed under the terms of the Modified BSD License (also known ...)
  • Author: Jupyter Development Team
  • Tags Interactive, Interpreter, Shell, Web
  • Requires: Python >=3.6
  • Provides-Extra: docs, test
Classifiers

Release history Release notifications | RSS feed

This version

4.0.2

4.0.1

4.0.0 yanked

Reason this release was yanked:

__version__ parsing is broken

4.0.0rc1 pre-release

4.0.0rc0 pre-release

4.0.0a1 pre-release

4.0.0a0 pre-release

3.2.1

3.2.0

3.1.1

3.1.0

3.0.0

3.0.0b1 pre-release

2.1.1

2.1.0

2.0.0

1.1.1

1.1.0

1.0.7

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

1.0.0rc1 pre-release

1.0.0rc0 pre-release

0.4.1

0.4.0

0.3.0

0.2.0

0.1.2

0.1.1

0.1.0

0.1.0b1 pre-release

0.1.0.dev pre-release

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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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