{ "info": { "author": "Tavish Armstrong", "author_email": "tavisharmstrong@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3" ], "description": "===============================\nNBDiff\n===============================\n\n.. image:: https://badge.fury.io/py/nbdiff.png\n :target: http://badge.fury.io/py/nbdiff\n \n.. image:: https://travis-ci.org/tarmstrong/nbdiff.png?branch=master\n :target: https://travis-ci.org/tarmstrong/nbdiff\n\n.. image:: https://pypip.in/d/nbdiff/badge.png\n :target: https://crate.io/packages/nbdiff?version=latest\n\n\nA tool for diffing and merging IPython Notebook files.\n\nThis project was built by a team of\nuniversity students from Concordia University. See\n`AUTHORS `__\nfor more information.\n\n* Free software: MIT license\n* Website: http://nbdiff.org.\n\nInstallation\n------------\n\nUsing Pip\n~~~~~~~~~\n\nIf you have pip installed:\n\n::\n\n $ pip install nbdiff\n\nFrom Source\n~~~~~~~~~~~\n\n1. Download the code from this repository\n2. Run ``python setup.py develop``\n\nConfigure Git/Mercurial\n~~~~~~~~~~~~~~~~~~~~~~~\n\n*Configuring nbmerge to work with your version control system can be helpful but is not required.*\n\nNBMerge is compatible with Mercurial out of the box by running ``hg merge --tool=nbmerge ``.\n\nGit, however, needs to be configured by adding the following to your ``.gitconfig`` file:\n\n::\n\n [mergetool \"nbmerge\"] \n cmd = nbmerge $LOCAL $BASE $REMOTE $MERGED\n\nAlternatively, you can run the following command to add this configuration automatically:\n\n::\n\n $ git config --global mergetool.nbmerge.cmd = \"nbmerge \\$LOCAL \\$BASE \\$REMOTE \\$MERGED\"\n\nYou can then run ``nbmerge`` from git like so:\n\n::\n\n $ git mergetool --tool=nbmerge\n\n\nUsage\n-----\n\nNBDiff\n~~~~~~\n\nNBDiff launches a server at ``localhost:5000`` and allows you to view a simple\n2-pane diff of two notebook files.\n\n::\n\n usage: nbdiff [-h] [before after]\n\n Produce a diffed IPython Notebook from before and after notebooks. If no\n arguments are given, nbdiff looks for modified notebook files in the version\n control system. The resulting diff is presented to the user in the browser at\n http://localhost:5000.\n\n positional arguments:\n before The notebook to diff against.\n after The notebook to compare `before` to.\n\n optional arguments:\n -h, --help show this help message and exit\n\n\nNBMerge\n~~~~~~~\n\nnbmerge launches\n\n::\n\n\n usage: nbmerge [-h] [local base remote [result]]\n\n nbmerge is a tool for resolving merge conflicts in IPython Notebook files. If\n no arguments are given, nbmerge attempts to find the conflicting file in the\n version control system. Positional arguments are available for integration\n with version control systems such as Git and Mercurial.\n\n Once nbmerge is run, the UI can be accessed at http://localhost:5000\n\n positional arguments:\n notebook\n\n optional arguments:\n -h, --help show this help message and exit\n\n\nDeveloping\n----------\n\nRun the Python tests\n~~~~~~~~~~~~~~~~~~~~\n\nTo get all of the dependencies necessary to test nbdiff, run:\n\n::\n\n $ pip install -r requirements-dev.txt\n\n\nTo run the python tests, run the following command:\n\n::\n\n $ python setup.py nosetests\n\nNBDiff adheres to `PEP-8 `__. To check the code\nagainst PEP-8, use ``flake8`` like so:\n\n::\n\n $ flake8 tests nbdiff\n\n\nTo check Python test coverage, install ``coverage`` and run the tests with the ``--with-coverage`` option.\n\n::\n\n $ pip install coverage\n $ python setup.py nosetests --with-coverage\n\n\nRun the JavaScript tests\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nFirst, install `node `__ and npm.\n\nSecond, install the JavaScript dependencies using ``npm``.\n\n::\n\n $ npm install\n\nFinally, run the tests with ``grunt``. You should output similar to the following.\nNote that ``grunt`` will not only run the tests, but check for common style problems with ``jshint``.\n\n::\n\n $ grunt\n\n Running \"qunit:files\" (qunit) task\n Testing src/test/index.html ...OK\n >> 14 assertions passed (21ms)\n\n Done, without errors.\n\n\n\n\n\nHistory\n-------\n\n\n1.0.0 (2014-03-28)\n++++++++++++++++++\n\n* End of the original capstone team project.\n* First release on PyPI\n\n1.0.3 (2014-04-15)\n++++++++++++++++++\n\n* IPython 2.0.0 support", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/tarmstrong/nbdiff", "keywords": "nbdiff", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "nbdiff", "package_url": "https://pypi.org/project/nbdiff/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/nbdiff/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/tarmstrong/nbdiff" }, "release_url": "https://pypi.org/project/nbdiff/1.0.3/", "requires_dist": null, "requires_python": null, "summary": "A tool for diffing and merging IPython Notebook files", "version": "1.0.3" }, "last_serial": 1061475, "releases": { "0.0.0": [ { "comment_text": "", "digests": { "md5": "e662ceba0d732e67ffa332addaf5af02", "sha256": "6b4f14d37f0801140dda4abb6aa614da61871f2328edd3c297be4e1c8d3e0362" }, "downloads": -1, "filename": "nbdiff-1.0.0.tar.gz", "has_sig": false, "md5_digest": "e662ceba0d732e67ffa332addaf5af02", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15298, "upload_time": "2014-03-28T20:41:21", "url": "https://files.pythonhosted.org/packages/29/1b/4641626996efabd16971734fd05e67b9cc88178e2c2aae2542a0a29dc82e/nbdiff-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "f5728676c2a932360b89b2982f815890", "sha256": "606851b6e0efc717545e76d58d1441b98d0cf2472bf7c6211fecbd0174514f19" }, "downloads": -1, "filename": "nbdiff-1.0.1.tar.gz", "has_sig": false, "md5_digest": "f5728676c2a932360b89b2982f815890", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18872, "upload_time": "2014-03-29T18:31:15", "url": "https://files.pythonhosted.org/packages/74/f8/5f8ec5644ac615793eba32682798c4c2a2187cee65d6b9db5842b61cade0/nbdiff-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "5980dca70ca87c42eba666a2554a1192", "sha256": "82aa3aa644766ea2c4beb12b8b2e6cf2decbfa7943b5feed6cf4ac19a5a90fd0" }, "downloads": -1, "filename": "nbdiff-1.0.2.tar.gz", "has_sig": false, "md5_digest": "5980dca70ca87c42eba666a2554a1192", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 218752, "upload_time": "2014-03-29T19:09:13", "url": "https://files.pythonhosted.org/packages/40/9d/925b41c8fab36eda77f01963da642932e38925e24521e83a4413cffea18d/nbdiff-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "f5b0a14b7e0156efccedc4132ed334e6", "sha256": "ec0e5fb884afd3c5e206da202609381deb021bad61fa3f2d22689d209ed2bbf8" }, "downloads": -1, "filename": "nbdiff-1.0.3.tar.gz", "has_sig": false, "md5_digest": "f5b0a14b7e0156efccedc4132ed334e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 219198, "upload_time": "2014-04-15T19:17:30", "url": "https://files.pythonhosted.org/packages/fb/a1/e3ff5d3936d8eb799f2a97ee15b36cc52b5cf227bf80134c7a85e35f2d37/nbdiff-1.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f5b0a14b7e0156efccedc4132ed334e6", "sha256": "ec0e5fb884afd3c5e206da202609381deb021bad61fa3f2d22689d209ed2bbf8" }, "downloads": -1, "filename": "nbdiff-1.0.3.tar.gz", "has_sig": false, "md5_digest": "f5b0a14b7e0156efccedc4132ed334e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 219198, "upload_time": "2014-04-15T19:17:30", "url": "https://files.pythonhosted.org/packages/fb/a1/e3ff5d3936d8eb799f2a97ee15b36cc52b5cf227bf80134c7a85e35f2d37/nbdiff-1.0.3.tar.gz" } ] }