Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jupyter/nbdime

Tools for diffing and merging of Jupyter notebooks.
https://github.com/jupyter/nbdime

diff diffing git hg jupyter jupyter-notebook jupyterlab-extension mercurial merge merge-driver mergetool vcs version-control

Last synced: 4 days ago
JSON representation

Tools for diffing and merging of Jupyter notebooks.

Host: GitHub
URL: https://github.com/jupyter/nbdime
Owner: jupyter
License: other
Created: 2015-11-16T09:25:53.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2024-09-21T17:10:47.000Z (3 months ago)
Last Synced: 2024-10-30T01:02:48.240Z (about 1 month ago)
Topics: diff, diffing, git, hg, jupyter, jupyter-notebook, jupyterlab-extension, mercurial, merge, merge-driver, mergetool, vcs, version-control
Language: TypeScript
Homepage: http://nbdime.readthedocs.io
Size: 14.1 MB
Stars: 2,672
Watchers: 42
Forks: 160
Open Issues: 93
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-jupyter-resources - GitHub - 22% open · ⏱️ 05.07.2022): (Jupyter-Notebook分享与格式转换)
best-of-jupyter - GitHub - 26% open · ⏱️ 05.09.2024): (Notebook Sharing & Conversion)
awesome-robotic-tooling - nbdime - Tools for diffing and merging of Jupyter notebooks. (Development Environment / Version Control)
awesome-robotic-tooling - nbdime - Tools for diffing and merging of Jupyter notebooks. (Development Environment / Version Control)
StarryDivineSky - jupyter/nbdime

README

        **[Installation](#installation)** |

**[Documentation](#documentation)** |

**[Contributing](#contributing)** |

**[Development Install](#development-install)** |

**[Testing](#testing)** |

**[License](#license)** |

**[Getting help](#getting-help)**

# [nbdime](https://github.com/jupyter/nbdime) Jupyter Notebook Diff and Merge tools

[![Test](https://github.com/jupyter/nbdime/actions/workflows/tests.yml/badge.svg)](https://github.com/jupyter/nbdime/actions/workflows/tests.yml)

[![codecov.io](https://codecov.io/github/jupyter/nbdime/coverage.svg?branch=master)](https://codecov.io/github/jupyter/nbdime?branch=master)

[![Documentation Status](https://readthedocs.org/projects/nbdime/badge/?version=latest)](http://nbdime.readthedocs.io/en/latest/?badge=latest)

[![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter)

`nbdime` provides tools for diffing and merging of [Jupyter Notebooks](https://jupyter-notebook.readthedocs.io).

- `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](docs/source/images/nbdiff-terminal.png)

Merging notebooks in a browser:

![web-merge](docs/source/images/nbmerge-web.png)

## Installation

Install nbdime with pip:

    pip install nbdime

See [the installation docs](https://nbdime.readthedocs.io/en/latest/installing.html) 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](https://github.com/jupyter/enhancement-proposals/pull/8).

## Contributing

If you would like to contribute to the project, please read our [contributor documentation](http://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html) and the [`CONTRIBUTING.md`](CONTRIBUTING.md).

## Development Install

To install a development version of nbdime, you will need [npm installed](https://nodejs.org/en/download/) and available on your PATH while installing.

For a **development install**, enter on the command line:

```bash

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

```

See [installation](https://nbdime.readthedocs.io/en/latest/installing.html#installing-latest-development-version) 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](https://github.com/codecov/browser-extension#codecov-extension) to view test coverage in the source browser on github.

See [testing](https://nbdime.readthedocs.io/en/latest/testing.html) 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](https://groups.google.com/forum/#!forum/jupyter).

## Resources

- [Reporting Issues](https://github.com/jupyter/nbdime/issues)

- [Documentation for nbdime](https://nbdime.readthedocs.io/en/latest/) | [PDF (latest)](https://media.readthedocs.org/pdf/nbdime/latest/nbdime.pdf)

- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) | [PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)

- [Project Jupyter website](https://jupyter.org)