Skip to main content

Use pytest's runner to discover and execute tests as cells of IPython notebooks

Project description

Plugin for pytest to run IPython notebooks as unit tests, relies on runipy to interface with the Notebook.

Define unit tests in IPython notebook cells (see example on nbviewer):

Example notebook

Run py.test to execute them:

Example output

Example

See the examples/ folder or a preview on nbviewer.

Features

  • Discover files named test*.ipynb
  • Run each cell of the notebook as a unit test (just use assert)
  • First line of each cell is the test name, either as docstring, comment or function name
  • A cell named fixture* or setup* is run before each of the following unit tests as a fixture
  • Add SKIPCI to a cell description to skip the test on Travis-CI (checks if the CI environment variable is defined)
  • IPython notebook kernel is restarted after each test
  • Each notebook is executed in the folder where the .ipynb file is located

Requirements

  • Python 2.7+, Python 3.2+
  • pytest
  • IPython Notebook 2.0+

Install

$ pip install pytest-ipynb

Author

Andrea Zonca

Credits

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pytest-ipynb-1.1.0.tar.gz (3.8 kB) Copy SHA256 hash SHA256 Source None Feb 18, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page