Package: opensarlab-oslnotify
opensarlab-oslnotifyA JupyterLab extension for OpenSARLab. On server startup, display current storage usage and any Google Calendar notifications.This extension is composed of a Python package namedopensarlab-oslnotifyfor the server extension and a NPM package namedopensarlab-oslnotifyfor the frontend extension.This extension will server a Toastr notification upon Jupyter server startup (specifcally page load). It displays notifications from the appropriate Calendar and the current storage usage.Required environment variables for the Calendar notification used with endpoint https://OPENSCIENCELAB_PORTAL_DOMAIN/user/notifications/OPENSCIENCELAB_LAB_SHORT_NAME?profile=OPENSARLAB_PROFILE_NAME:OPENSCIENCELAB_PORTAL_DOMAINOPENSCIENCELAB_LAB_SHORT_NAMEOPENSARLAB_PROFILE_NAMERequirementsJupyterLab >= 4.0.0InstallTo install the extension, execute:pipinstallopensarlab-oslnotifyUninstallTo remove the extension, execute:pipuninstallopensarlab-oslnotifyTroubleshootIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistContributingDevelopment 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 opensarlab-oslnotify directory# Install package in development modepipinstall-e"."# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Server extension must be manually installed in develop modejupyterserverextensionenableopensarlab-oslnotify# Rebuild extension Typescript source after making changesjlpmbuildYou 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 neededjlpmwatch# 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 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=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisableopensarlab-oslnotify
pipuninstallopensarlab-oslnotifyIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedopensarlab-oslnotifywithin that folder.Packaging the extensionSeeRELEASE