nbdiff 1.0.3

===============================
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=latest


A tool for diffing and merging IPython Notebook files.

This project was built by a team of
university 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:

::

$pipinstallnbdiffFromSource1.Downloadthecodefromthisrepository2.Run‘‘pythonsetup.pydevelop‘‘ConfigureGit/Mercurial\ast Configuringnbmergetoworkwithyourversioncontrolsystemcanbehelpfulbutisnotrequired.\ast NBMergeiscompatiblewithMercurialoutoftheboxbyrunning‘‘hgmerge--tool=nbmerge<branch>‘‘.Git,however,needstobeconfiguredbyaddingthefollowingtoyour‘‘.gitconfig‘‘file:::[mergetool"nbmerge"]cmd=nbmerge$LOCAL $BASE$REMOTE $MERGEDAlternatively,youcanrunthefollowingcommandtoaddthisconfigurationautomatically:::$ git config --global mergetool.nbmerge.cmd = "nbmerge $LOCAL $BASE $REMOTE $MERGED"

You can then run ``nbmerge`` from git like so:

::

$gitmergetool--tool=nbmergeUsage-----NBDiffNBDifflaunchesaserverat‘‘localhost:5000‘‘andallowsyoutoviewasimple2-panediffoftwonotebookfiles.::usage:nbdiff[-h][beforeafter]ProduceadiffedIPythonNotebookfrombeforeandafternotebooks.Ifnoargumentsaregiven,nbdifflooksformodifiednotebookfilesintheversioncontrolsystem.Theresultingdiffispresentedtotheuserinthebrowserathttp://localhost:5000.positionalarguments:beforeThenotebooktodiffagainst.afterThenotebooktocompare‘before‘to.optionalarguments:-h,--helpshowthishelpmessageandexitNBMergenbmergelaunches::usage:nbmerge[-h][localbaseremote[result]]nbmergeisatoolforresolvingmergeconflictsinIPythonNotebookfiles.Ifnoargumentsaregiven,nbmergeattemptstofindtheconflictingfileintheversioncontrolsystem.PositionalargumentsareavailableforintegrationwithversioncontrolsystemssuchasGitandMercurial.Oncenbmergeisrun,theUIcanbeaccessedathttp://localhost:5000positionalarguments:notebookoptionalarguments:-h,--helpshowthishelpmessageandexitDeveloping----------RunthePythontestsTogetallofthedependenciesnecessarytotestnbdiff,run:::$ pip install -r requirements-dev.txt


To run the python tests, run the following command:

::

$\text{Missing open brace for subscript}$ flake8 tests nbdiff


To check Python test coverage, install ``coverage`` and run the tests with the ``--with-coverage`` option.

::

$pipinstallcoverage$ python setup.py nosetests --with-coverage


Run the JavaScript tests
~~~~~~~~~~~~~~~~~~~~~~~~

First, install `node <http://nodejs.org/>`__ and npm.

Second, install the JavaScript dependencies using ``npm``.

::

$npminstallFinally,runthetestswith‘‘grunt‘‘.Youshouldoutputsimilartothefollowing.Notethat‘‘grunt‘‘willnotonlyrunthetests,butcheckforcommonstyleproblemswith‘‘jshint‘‘.::$ grunt

Running "qunit:files" (qunit) task
Testing 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 PyPI

1.0.3 (2014-04-15)
++++++++++++++++++

* IPython 2.0.0 support