Skip to main content

testipynb

Project description

Latest PyPI version Documentation Status Travis CI build status coverage MIT license

Unit-testing for a collection of jupyter notebooks. testipynb relies on nbconvert to run the notebooks and catches errors so that they are output (with syntax highlighting!) when unit-tests are run.

why?

  • If you want to share your notebooks and be confident that they _should_ work on someone else’s machine

  • If you are using notebooks to generate figures in a publication and want to ensure they are reproducible (powerful when connected with cron jobs on travis-ci)

https://raw.githubusercontent.com/opengeophysics/testipynb/master/docs/images/testing_syntax_highlighting.png

installation

pip install testipynb

usage

import testipynb

NBDIR = '../notebooks'

Test = testipynb.TestNotebooks(directory=NBDIR)
Test.assertTrue(Test.run_tests())

or in a unit-test file:

import testipynb
import unittest

NBDIR = '../notebooks'

Test = testipynb.TestNotebooks(directory=NBDIR, timeout=2100)
TestNotebooks = Test.get_tests()

if __name__ == "__main__":
    unittest.main()

connections

testipynb is used in:

If you use testipynb in one of your repositories and would like it listed, please edit this file

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

testipynb-0.0.2.tar.gz (5.9 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page