Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
docs/ | H | 03-May-2022 | - | 2,493 | 1,635 | |
jupyter-config/ | H | 25-Oct-2021 | - | 22 | 19 | |
nbdime/ | H | 25-Oct-2021 | - | 22,461 | 17,124 | |
nbdime.egg-info/ | H | 03-May-2022 | - | 127 | 86 | |
packages/ | H | 25-Oct-2021 | - | 39,193 | 32,649 | |
CONTRIBUTING.md | H A D | 01-Jun-2016 | 127 | 4 | 2 | |
LICENSE.md | H A D | 07-May-2018 | 2.9 KiB | 61 | 45 | |
MANIFEST.in | H A D | 25-Oct-2021 | 787 | 41 | 34 | |
PKG-INFO | H A D | 25-Oct-2021 | 5 KiB | 127 | 86 | |
README.md | H A D | 25-Oct-2021 | 3.9 KiB | 95 | 57 | |
conftest.py | H A D | 08-Aug-2019 | 642 | 18 | 13 | |
lerna.json | H A D | 08-Aug-2019 | 96 | 8 | 7 | |
package.json | H A D | 25-Oct-2021 | 743 | 22 | 21 | |
pyproject.toml | H A D | 25-Oct-2021 | 120 | 4 | 3 | |
pytest.ini | H A D | 21-Mar-2018 | 62 | 4 | 3 | |
setup.cfg | H A D | 25-Oct-2021 | 514 | 35 | 28 | |
setup.py | H A D | 25-Oct-2021 | 5 KiB | 172 | 136 | |
setupbase.py | H A D | 25-Oct-2021 | 22.9 KiB | 728 | 541 | |
tsconfig.json | H A D | 08-Aug-2019 | 183 | 10 | 9 | |
tsconfig_base.json | H A D | 14-Jan-2021 | 382 | 18 | 17 |
README.md
1**[Installation](#installation)** | 2**[Documentation](#documentation)** | 3**[Contributing](#contributing)** | 4**[Development Install](#development-install)** | 5**[Testing](#testing)** | 6**[License](#license)** | 7**[Getting help](#getting-help)** 8 9# [nbdime](https://github.com/jupyter/nbdime) Jupyter Notebook Diff and Merge tools 10 11[![Build Status](https://travis-ci.org/jupyter/nbdime.svg?branch=master)](https://travis-ci.org/jupyter/nbdime) 12[![codecov.io](https://codecov.io/github/jupyter/nbdime/coverage.svg?branch=master)](https://codecov.io/github/jupyter/nbdime?branch=master) 13[![Documentation Status](https://readthedocs.org/projects/nbdime/badge/?version=latest)](http://nbdime.readthedocs.io/en/latest/?badge=latest) 14[![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter) 15 16`nbdime` provides tools for diffing and merging of [Jupyter Notebooks](https://jupyter-notebook.readthedocs.io). 17 18- `nbdiff` compare notebooks in a terminal-friendly way 19- `nbmerge` three-way merge of notebooks with automatic conflict resolution 20- `nbdiff-web` shows you a rich rendered diff of notebooks 21- `nbmerge-web` gives you a web-based three-way merge tool for notebooks 22- `nbshow` present a single notebook in a terminal-friendly way 23 24Diffing notebooks in the terminal: 25 26![terminal-diff](docs/source/images/nbdiff-terminal.png) 27 28Merging notebooks in a browser: 29 30![web-merge](docs/source/images/nbmerge-web.png) 31 32## Installation 33 34Install nbdime with pip: 35 36 pip install nbdime 37 38See [the installation docs](https://nbdime.readthedocs.io/en/latest/installing.html) for more installation details and development installation instructions. 39 40## Documentation 41 42See the latest documentation at https://nbdime.readthedocs.io. 43 44See also description and discussion in the [Jupyter Enhancement Proposal](https://github.com/jupyter/enhancement-proposals/pull/8). 45 46## Contributing 47 48If 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). 49 50## Development Install 51 52To install a development version of nbdime, you will need [npm installed](https://nodejs.org/en/download/) and available on your PATH while installing. 53 54For a **development install**, enter on the command line: 55 56```bash 57pip install -e git+https://github.com/jupyter/nbdime#egg=nbdime 58``` 59 60See [installation](https://nbdime.readthedocs.io/en/latest/installing.html#installing-latest-development-version) documentation for additional detail, particularly related to performing 61a dev install for working on the browser script code. 62 63## Testing 64 65Install the test requirements: 66 67 pip install nbdime[test] 68 69To run Python tests locally, enter on the command line: `pytest` 70 71To run Javascript tests locally, enter: `npm test` 72 73Install the [codecov browser extension](https://github.com/codecov/browser-extension#codecov-extension) to view test coverage in the source browser on github. 74 75See [testing](https://nbdime.readthedocs.io/en/latest/testing.html) documentation for additional detail. 76 77## License 78 79We use a shared copyright model that enables all contributors to maintain the 80copyright on their contributions. 81 82All code is licensed under the terms of the revised BSD license. 83 84## Getting help 85 86We encourage you to ask questions on the [mailing list](https://groups.google.com/forum/#!forum/jupyter). 87 88## Resources 89 90- [Reporting Issues](https://github.com/jupyter/nbdime/issues) 91- [Documentation for nbdime](https://nbdime.readthedocs.io/en/latest/) | [PDF (latest)](https://media.readthedocs.org/pdf/nbdime/latest/nbdime.pdf) 92 93- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) | [PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf) 94- [Project Jupyter website](https://jupyter.org) 95