Productionise and schedule your Jupyter Notebooks, just as interactively as you wrote them. Notebooker is a webapp which can execute and parametrise Jupyter Notebooks as soon as they have been committed to git. The results are stored in MongoDB and searchable via the web interface, essentially turning your Jupyter Notebook into a production-style web-based report in a few clicks.

Run a Jupyter notebook as a report with parameters

Execute Jupyter notebooks either on the webservice or command line

View the output of notebooks as static HTML

All results are accessible from the home page

Drill down into each template's results

Getting started

See the documentation at https://notebooker.readthedocs.io/ for installation instructions.

Notebooker has been tested on Linux, Windows 10, and OSX; the webapp has been tested on Google Chrome.

If you want to explore an example right away, you can use docker-compose:

cd docker
docker-compose up

That will expose Notebooker at http://localhost:8080/ with the example templates.

Contributors

Notebooker has been actively maintained at Man Group since late 2018, with the original concept built by Jon Bannister. It would not have been possible without contributions from:

• Douglas Bruce
• Franek Jemiolo
• Sam Ratcliff
• Matthew Dodds
• Dominik Christ

And these fantastic projects:

• Jupytext
• papermill
• nbconvert
• Fomantic-UI

0.4.3 (2022-06-24)

• Feature: The results page now includes a "View Stdout" button to view and copy stdout from the notebook run
• Improvement: Prometheus improvement to allow increase() metric to be used in alerting

0.4.2 (2022-04-27)

• Improvement: Prometheus metrics now record number of successes/failures which have been captured by the webapp.
• Improvement: Unpinned nbconvert and added ipython_genutils dependency

0.4.1 (2022-03-09)

• Improvement: The email "from" address is now fully configurable.
• Bugfix: The default "from" email address domain is no longer non-existent.
• Improvement: --running-timeout parameter allows customization of max allowed notebook runtime

0.4.0 (2021-12-17)

• Improvement: The index page has been overhauled to be a lot more user-friendly, divided up by notebook template name.

0.3.2 (2021-11-10)

• Feature: .ipynb files are now natively supported and can be used as Notebook Templates (#57)

0.3.1 (2021-10-29)

• Improvement: index page should be a lot quicker due to storage improvements.
• Bugfix: hide_code and generate_pdf options now work as intended with the scheduler.
• Bugfix: Large notebooks were causing serialisation errors; now safely stored in gridfs.
• Incompatibility: Reports run with this version onwards will not be readable by older versions of Notebooker.

0.3.0 (2021-10-05)

• Major feature: scheduling natively within Notebooker
  • See the docs for more info.
• Bugfix: Newer versions of uuid now work properly with Notebooker
• Improvement: See the version number in the Notebooker GUI and with a /core/version GET call.

0.2.1 (2021-02-11)

• Bugfix: notebooker_execute entrypoint should now work as intended
• Bugfix: Sanity and template regression tests should now work as intended
• Improvement: Specifying a git repo should be a little simpler

0.2.0 (2020-12-17)

• Code output can now be hidden from PDF and email output! Either check the box in the "Run Report" dialog or, using the cli, use the new --hide-code option.
• Performance improvement for queries

0.1.0 (2020-11-30)

Support for database plugins and tidying up configuration to be consistent across the board.

Breaking changes

• 3 primary entrypoints have been consolidated under one - notebooker-cli, e.g. notebooker-cli start-webapp and notebooker-cli execute-notebook. Run notebooker-cli --help for more info.
• In config, PY_TEMPLATE_DIR has been renamed to PY_TEMPLATE_BASE_DIR
• In config, GIT_REPO_TEMPLATE_DIR has been renamed to PY_TEMPLATE_SUBDIR

0.0.2 (2020-10-25)

Bugfixes & cleanup Docker support (#14)

0.0.1 (2020-09-04)

Initial release of Notebooker