Package: opensarlab-notifications
opensarlab_notificationsA JupyterLab frontend and backend extension for OpenSARLab that provides calendar notification popups within JupyterLab.The extension needs to have access to the following environment variables within the JupyterLab server extension:OPENSARLAB_PROFILE_NAME: The name of the OSL user profile being usedOPENSARLAB_LAB_SHORT_NAME: The short name of the lab deployment (as used by the OSL Portal)OPENSARLAB_PORTAL_DOMAIN: The schema+host domain of the OSL Portal (e.g.,https://opensarlab.asf.alaska.edu)The server extension part retrieves from the/notifications/{short_lab_name}?profile={profile_name}Portal service the calendar notifications
in JSON format which then passes totoastrwithin the frontend extension for display.RequirementsJupyterLab >= 3.0InstallTo install the extension, execute:pipinstallopensarlab_notificationsUninstallTo remove the extension, execute:pipuninstallopensarlab_notificationsTroubleshootIf 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_notifications 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_notifications# 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 terminal# To avoid polluting the parent environment, prepend the needed Environment Variables.OPENSARLAB_PROFILE_NAME=opensarlab_profile_name\OPENSARLAB_LAB_SHORT_NAME=opensarlab_lab_short_name\OPENSARLAB_PORTAL_DOMAIN=opensarlab_portal_domain\jupyterlabWith 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=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisableopensarlab_notifications
pipuninstallopensarlab_notificationsIn 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-notificationswithin that folder.Packaging the extensionSeeRELEASE