[IPython-dev] nosebook: notebooks-as-documentation-as-tests

Nicholas Bollweg nick.bollweg at gmail.com
Sat Feb 14 17:55:35 EST 2015

Just wanted to plug a little nose extension that I've just gotten working:


nosebook finds notebooks that look like tests, and for each notebook,
starts a kernel, runs the code cells and compares the output to what was in
the original notebook. It can be configured to find different notebooks, as
well as strip out nasty <xyz at 0x1234> bits.

It's not a full nose/notebook integration, as it lacks lots of features
like setup and teardown, but should make it easier to keep documentation in
notebooks fresh with respect to code changes.

It reuses IPython.kernel.tests.util, which is probably not the best
long-term solution, as that probably isn't meant as a public API, but it
was the quickest way to get it up and running. Right now it's not backward
compatible with IPython 2.x, but that might be added if there is outcry.

Interested in feedback!
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/ipython-dev/attachments/20150214/7c89e254/attachment.html>

More information about the IPython-dev mailing list