This package provides a Jupyter notebook cell magic %%notify that notifies the user upon completion of a potentially long-running cell via a browser push notification. Use cases include long-running machine learning models, grid searches, or Spark computations. This magic allows you to navigate away to other work (or even another Mac desktop entirely) and still get a notification when your cell completes.
The extension has currently been tested in Chrome (Version: 58.0.3029) and Firefox (Version: 53.0.3).
Note: Firefox also makes an audible bell sound when the notification fires (the sound can be turned off in OS X as described here).
To use the package, install it via pip directly:
pip install jupyternotify
or add it to the requirements.txt of your repo.
To install directly from source:
git clone git@github.com:ShopRunner/jupyter-notify.git
cd jupyter-notify/
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
jupyter notebookimport jupyternotify
ip = get_ipython()
ip.register_magics(jupyternotify.JupyterNotifyMagics)Add the following lines to your ipython startup file:
c.InteractiveShellApp.exec_lines = [
'import jupyternotify',
'ip = get_ipython()',
'ip.register_magics(jupyternotify.JupyterNotifyMagics)'
]
The .ipython startup file can be generated with ipython profile create [profilename] and will create a configuration file at ~/.ipython/profile_[profilename]/ipython_config.py'. Leaving [profilename] blank will create a default profile (see this for more info).
To test the extension, try
%%notify
import time
time.sleep(5)
You may specify options while loading the magic:
import jupyternotify
ip = get_ipython()
ip.register_magics
5613
(jupyternotify.JupyterNotifyMagics(
ip,
option_name="option_value"
))The following options exist:
require_interaction- Boolean, default False. When this is true, notifications will remain on screen until dismissed. This feature is currently only available in Google Chrome.