catalyst-cooperative / pudl

The Public Utility Data Liberation Project provides analysis-ready energy system data to climate advocates, researchers, policymakers, and journalists.
https://catalyst.coop/pudl
MIT License
456 stars 106 forks source link

Integrate Jupyter notebooks into automated tests & Travis CI #227

Closed zaneselvans closed 4 years ago

zaneselvans commented 5 years ago

Currently we have no process for ensuring that our notebooks remain valid as the underlying codebase changes. In most cases this isn't a huge issue -- many of them are really scratch paper -- but it would be useful to make sure a few of them continue functioning:

It looks like there are several plugins to PyTest that may be able to help achieve this goal, and get the test system to run specified collections of notebooks. nbval is the best looking option I've come across. Documentation here

zaneselvans commented 4 years ago

The nbval tox environment does most of this -- closing and replacing w/ a re-org of notebooks into travis / non-travis tested ones...