Skip to main content

A unit testing framework for Jupyter Notebooks

Project description

Build Status image Documentation Status Python 3.6 Python 3.7 Python 3.8 Code style: black

testbook

WARNING: This is the old package name nteract-testbook -- please install testbook in the future as no new releases are going out for this old package name.

testbook is a unit testing framework extension for testing code in Jupyter Notebooks.

Previous attempts at unit testing notebooks involved writing the tests in the notebook itself. However, testbook will allow for unit tests to be run against notebooks in separate test files, hence treating .ipynb files as .py files.

testbook helps you set up conventional unit tests for your Jupyter Notebooks.

Here is an example of a unit test written using testbook

Consider the following code cell in a Jupyter Notebook:

def sum(a, b):
   return a + b

You would write a unit test using testbook in a Python file as follows:

import testbook



@testbook.testbook('/path/to/notebook.ipynb', execute=True)
def test_notebook(tb):
   sum = tb.ref("sum")

   assert sum(1, 2) == 3

Installing testbook

pip install nteract-testbook

Documentation

See readthedocs for more in-depth details.

Development Guide

Read CONTRIBUTING.md for guidelines on how to setup a local development environment and make code changes back to testbook.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

nteract_testbook-0.1.3-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file nteract_testbook-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: nteract_testbook-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for nteract_testbook-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 913b40fbbd8114d293becc88980bad7a7567dbbb1a38361361825fe983c2e4d8
MD5 ff73b9793e143c28b31a493bfa47152c
BLAKE2b-256 3dc540bc4d8d3302d5c195239dcddae78a69e6afbd785ff7ff46be21363f4a11

See more details on using hashes here.

Provenance

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