Skip to main content

Tool for parametrizing, executing, and displaying Jupyter Notebooks as reports.

Project description

Notebooker

Productionise 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.

CircleCI

Run a Jupyter notebook as a report with parameters

Screenshot of "Run A Report" dialog

Execute Jupyter notebooks either on the webservice or command line

Screenshot of Executing a notebook

View the output of notebooks as static HTML

Screenshot of some notebook results

All results are accessible from the home page

Screenshot of Executing a notebook

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:

And these fantastic projects:

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notebooker-0.1.0.tar.gz (28.8 MB view details)

Uploaded Source

Built Distributions

notebooker-0.1.0-py3.7.egg (35.8 MB view details)

Uploaded Source

notebooker-0.1.0-py3.6.egg (35.8 MB view details)

Uploaded Source

notebooker-0.1.0-py2.py3-none-any.whl (36.4 MB view details)

Uploaded Python 2 Python 3

File details

Details for the file notebooker-0.1.0.tar.gz.

File metadata

  • Download URL: notebooker-0.1.0.tar.gz
  • Upload date:
  • Size: 28.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.9

File hashes

Hashes for notebooker-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2d7be2cee4152bf4e6bc7f252be2b7baabadf84146535f215a57e5386af97743
MD5 31392f5d49f5ecccc7e086434364771d
BLAKE2b-256 ea43bc74876c7fc16d901348eb8562e5b37284dfff598d966ad162ed50e97a59

See more details on using hashes here.

Provenance

File details

Details for the file notebooker-0.1.0-py3.7.egg.

File metadata

  • Download URL: notebooker-0.1.0-py3.7.egg
  • Upload date:
  • Size: 35.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.9

File hashes

Hashes for notebooker-0.1.0-py3.7.egg
Algorithm Hash digest
SHA256 0d254f6ec5055aa839d1a890688bbd20993834cd8684a3e2cb45ee6144b749eb
MD5 bfc5d424113556347f65055e3a94bacb
BLAKE2b-256 6c806d72a4c8c8f5276a9f9b7ba4fa7fd591d12d3a059d102cce9f923992e6ab

See more details on using hashes here.

Provenance

File details

Details for the file notebooker-0.1.0-py3.6.egg.

File metadata

  • Download URL: notebooker-0.1.0-py3.6.egg
  • Upload date:
  • Size: 35.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.6.12

File hashes

Hashes for notebooker-0.1.0-py3.6.egg
Algorithm Hash digest
SHA256 81ceb72cd4067742ef841b80dcce2e2311003ce96cb1f635d755213ba10d8f65
MD5 2a4dbe8234de8273f6a931bd21ee184c
BLAKE2b-256 6657b30fae10210421c99c8bd94f2913d9292dd944b6fa7b41e5388fb8e1927a

See more details on using hashes here.

Provenance

File details

Details for the file notebooker-0.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: notebooker-0.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 36.4 MB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.6.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.9

File hashes

Hashes for notebooker-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 72152502d4b8936c8ed47eef83cb263d4aad7bb763a88b236baba51458e319f3
MD5 77282a86bd1f41e0052e7d1ce2fe0396
BLAKE2b-256 f686d28047d6e71c3764d88ee6e348e0695bfd0221d87e9fd457062edde70e53

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page