Package: nbdiff
===============================NBDiff===============================.. image:: https://badge.fury.io/py/nbdiff.png:target: http://badge.fury.io/py/nbdiff.. image:: https://travis-ci.org/tarmstrong/nbdiff.png?branch=master:target: https://travis-ci.org/tarmstrong/nbdiff.. image:: https://pypip.in/d/nbdiff/badge.png:target: https://crate.io/packages/nbdiff?version=latestA tool for diffing and merging IPython Notebook files.This project was built by a team ofuniversity students from Concordia University. See`AUTHORS <https://github.com/tarmstrong/nbdiff/blob/master/AUTHORS.rst>`__for more information.* Free software: MIT license* Website: http://nbdiff.org.Installation------------Using Pip~~~~~~~~~If you have pip installed:::$ pip install nbdiffFrom Source~~~~~~~~~~~1. Download the code from this repository2. Run ``python setup.py develop``Configure Git/Mercurial~~~~~~~~~~~~~~~~~~~~~~~*Configuring nbmerge to work with your version control system can be helpful but is not required.*NBMerge is compatible with Mercurial out of the box by running ``hg merge --tool=nbmerge <branch>``.Git, however, needs to be configured by adding the following to your ``.gitconfig`` file:::[mergetool "nbmerge"]cmd = nbmerge $LOCAL $BASE $REMOTE $MERGEDAlternatively, you can run the following command to add this configuration automatically:::$ git config --global mergetool.nbmerge.cmd = "nbmerge \$LOCAL \$BASE \$REMOTE \$MERGED"You can then run ``nbmerge`` from git like so:::$ git mergetool --tool=nbmergeUsage-----NBDiff~~~~~~NBDiff launches a server at ``localhost:5000`` and allows you to view a simple2-pane diff of two notebook files.::usage: nbdiff [-h] [before after]Produce a diffed IPython Notebook from before and after notebooks. If noarguments are given, nbdiff looks for modified notebook files in the versioncontrol system. The resulting diff is presented to the user in the browser athttp://localhost:5000.positional arguments:before      The notebook to diff against.after       The notebook to compare `before` to.optional arguments:-h, --help  show this help message and exitNBMerge~~~~~~~nbmerge launches::usage: nbmerge [-h] [local base remote [result]]nbmerge is a tool for resolving merge conflicts in IPython Notebook files. Ifno arguments are given, nbmerge attempts to find the conflicting file in theversion control system. Positional arguments are available for integrationwith version control systems such as Git and Mercurial.Once nbmerge is run, the UI can be accessed at http://localhost:5000positional arguments:notebookoptional arguments:-h, --help  show this help message and exitDeveloping----------Run the Python tests~~~~~~~~~~~~~~~~~~~~To get all of the dependencies necessary to test nbdiff, run:::$ pip install -r requirements-dev.txtTo run the python tests, run the following command:::$ python setup.py nosetestsNBDiff adheres to `PEP-8 <http://www.python.org/dev/peps/pep-0008/>`__. To check the codeagainst PEP-8, use ``flake8`` like so:::$ flake8 tests nbdiffTo check Python test coverage, install ``coverage`` and run the tests with the ``--with-coverage`` option.::$ pip install coverage$ python setup.py nosetests --with-coverageRun the JavaScript tests~~~~~~~~~~~~~~~~~~~~~~~~First, install `node <http://nodejs.org/>`__ and npm.Second, install the JavaScript dependencies using ``npm``.::$ npm installFinally, run the tests with ``grunt``. You should output similar to the following.Note that ``grunt`` will not only run the tests, but check for common style problems with ``jshint``.::$ gruntRunning "qunit:files" (qunit) taskTesting src/test/index.html ...OK>> 14 assertions passed (21ms)Done, without errors.History-------1.0.0 (2014-03-28)++++++++++++++++++* End of the original capstone team project.* First release on PyPI1.0.3 (2014-04-15)++++++++++++++++++* IPython 2.0.0 support