Skip to main content

testipynb

Project description

Latest PyPI version Documentation Status Travis CI build status 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/lheagy/testipynb/master/docs/images/testing_syntax_highlighting.png

installation

pip install testipynb

usage

import testipynb
import unittest

NBDIR = '../notebooks'

class TestNotebooks(unittest.TestCase):

    def test_notebooks(self):
        Test = testipynb.TestNotebooks(directory=NBDIR)
        self.assertTrue(Test.run_tests())

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

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.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

testipynb-0.0.1-py2.py3-none-any.whl (6.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file testipynb-0.0.1.tar.gz.

File metadata

  • Download URL: testipynb-0.0.1.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for testipynb-0.0.1.tar.gz
Algorithm Hash digest
SHA256 84c8e96d235f3f824e9b5429dcda7eeae44ae06823197fa19b04ce1af1b62ca4
MD5 7a73babc840f0eca449d7db8fd89c3bd
BLAKE2b-256 7f4356d8050ac3084065d959f2ea8db4537d9002663d8e8a269ca73b5cca8330

See more details on using hashes here.

File details

Details for the file testipynb-0.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for testipynb-0.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9e560cf81e8d9cd72c445c9e568f11f18d58f43fcc5da9c4c77236d6a96e91ad
MD5 704469d4ed1d2acf84012abc16cb00a8
BLAKE2b-256 6daeb8725dbb0e24ca313046e70e27aced03db30de9183c91cce8170f173f017

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page