Git Product home page Git Product logo

pytest-ipynb's Introduction

pytest-ipynb

Plugin for pytest to run ipython/jupyter notebooks as unit and integration tests.

It allows you to put both .py and .ipynb test files inside your normal test suite.

It currently relies on runipy to interface with the Notebook.

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

Run py.test to execute them:

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)
  • Each notebook is executed in the folder where the .ipynb file is located

Requirements

  • Python 3.6+
  • pytest
  • ipython-notebook 4.0+

Install

pip install git+https://github.com/stas00/pytest-ipynb.git

Author

Stas Bekman

Credits

  • This work is a fork of a no-longer maintained original pytest-ipynb, by Andrea Zonca.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.