Readme


Warning

This repository is no longer maintain please migrate to testbook.

testbook is better coded, offers more functionalities and has a wider community.


Dirty tricks to run python notebooks

PyPI version test codecov Documentation Status Binder License: MIT

view image on github

Purpose

Testing an idea is sometimes more easily done by calling a python notebook in a python code. It is as dirty, filthy and ugly as a wild hairy swine with horns… But if you can prove the value of your idea, why not try it out immediatly with boar.

Read more at ./POST.md

Installation

Requirements: Python 3 pip

The package is available on pypi: https://pypi.org/project/boar/

To install, execute:

pip install boar

Practice

I used this method in CI tasks to make sure tutorials associated to a project stay up-to-date.

I would not recommend relying this trick on a long term product.

Usage

More information at ./USAGE.md.

Reference

Medium

https://medium.com/@alexandre.cameron/start-testing-your-python-notebooks-5903d917c3cb

Documentation

https://boar.readthedocs.io/en/latest/

Source

https://github.com/alexandreCameron/boar