Package: jupyterlab-notify
jupyterlab-notifyJupyterLab extension to notify cell completionThis is inspired by the notebook versionhere.UsageRegister magics%load_extjupyterlab_notifyNotify completion of single cell:%%notifyimporttimetime.sleep(1)Mail output upon completion (with optional title for successfull execution)%%notify--mail--success'Long-running cell in <foo> notebook is done!'time.sleep(1)Note:Mail requires/assumes that you have an SMTP server running on "localhost" - referSMTP docfor more details.
In case this assumption does not hold true for you, please open an issue with relevant details.Failure scenarios%%notify-f'Long-running cell in <foo> notebook failed'raiseValueErrorThreshold-based notifications (unit in seconds)%notify_all--threshold1time.sleep(1)Once enabled,notify_allwill raise a notification for cells that either exceed the given threshold or raise exception. This ability can also be used to check if/when all cells in a notebook completes execution. For instance,# In first cell%notify_all-t86400-f'Notebook execution failed'# ...# ...# In last cell%%notify-s'Notebook execution completed'Disable notifications%notify_all--disabletime.sleep(1)Learn more%%notify?%notify_all?TroubleshootIf you notice that the desktop notifications are not showing up, check the below:Make sure JupyterLab is running in a secure context (i.e. either using HTTPS or localhost)If you've previously denied notification permissions for the site, update the browser settings accordingly. In Chrome, you can do so by navigating toSetttings -> Privacy and security -> Site Settings -> Notificationsand updating the permissions against your JupyterLab URL.Verify that notifications work for your browser. You may need to configure an OS setting first. You can test onthis site.RequirementsJupyterLab >= 4.0InstallTo install this package withpiprunpipinstalljupyterlab_notifyContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the jupyterlab_notify directory# Install package in development modepipinstall-e.# Link your development version of the extension with JupyterLabjupyter-labextensiondevelop.--overwrite# Rebuild extension Typescript source after making changesjlpmrunbuildYou can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.# Watch the source directory in one terminal, automatically rebuilding when neededjlpmrunwatch# Run JupyterLab in another terminaljupyterlabWith the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).By default, thejlpm run buildcommand generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:jupyterlabbuild--minimize=FalseUninstallpipuninstalljupyterlab_notifyPublishingBefore starting, you'll need to have run:pip install twine jupyter_packagingUpdate the version inpackage.jsonand update the release date inCHANGELOG.mdCommit the change in step 1, tag it, then push itgit commit -am <msg>
git tag vX.Z.Y
git push && git push --tagsCreate the artifactsrm -rf dist
python setup.py sdist bdist_wheelTest this against the test pypi. You can then install from here to test as well:twine upload --repository-url https://test.pypi.org/legacy/ dist/*
# In a new venv
pip install --index-url https://test.pypi.org/simple/ jupyterlab_notifyUpload this to pypi:twine upload dist/*Uninstallpipuninstalljupyterlab_notifyHistoryThis plugin was contributed back to the community by theD. E. Shaw group.LicenseThis project is released under aBSD-3-Clause license.We love contributions! Before you can contribute, please sign and submit thisContributor License Agreement (CLA).
This CLA is in place to protect all users of this project."Jupyter" is a trademark of the NumFOCUS foundation, of which Project Jupyter is a part.