Skip to content

Tools for running checks on computational notebooks

Notifications You must be signed in to change notification settings

gmlc-dispatches/nbcheck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 

Repository files navigation

nbcheck: tools for checking notebooks

The tools contained in this repository are being developed as part of the GMLC-DISPATCHES project. Unless explicitly noted, their usage is bound to the same copyrights, license, etc as specificed in the main DISPATCHES repository at https://github.com/gmlc-dispatches/dispatches.

Quickstart

Installation

# install from 0.2.0 tag
pip install "git+https://github.com/gmlc-dispatches/[email protected]"

# install from current `main` branch
pip install "git+https://github.com/gmlc-dispatches/nbcheck@main"

# install from commit whose SHA starts with `abcd123`
pip install "git+https://github.com/gmlc-dispatches/nbcheck@abcd123"

Usage

# run nbcheck with static checks only
pyest --nbcheck=static

# run nbcheck with both static and exec checks
pytest --nbcheck=static --nbcheck=exec

# disable the built-in `python` plugin to only run test items created by nbcheck
pytest --nbcheck=static --nbcheck=exec -p no:python

About

Tools for running checks on computational notebooks

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages