Package: jupyterlab-server-timer
jupyterlab_server_timerA JupyterLab extension that displays the remaining server run time in the status bar.This extension is best paired with a spawner such asbatchspawner. It allows the user to see when the job running the notebook is going to be terminated.The extension checks for two environment variables:JOB_START_TIMEcontains a UTC timestamp of the start time of the job. If absent then the time when the notebook becomes ready is used instead. Since it can take a few seconds to start the notebook the time measurement will not be completely accurate in this case and a hard-wired safety margin of 20 seconds will be deduced from the runtime.JOB_RUN_TIMEcontains the number of seconds the server will run. If absent the default is3600.An modified examplebatch_script.shforslurmspawnerthat sets the variables could look like this:...#SBATCH --export=JOB_START_TIME,JOB_RUN_TIME,{{keepvars}}...exportJOB_START_TIME=$(date+%s)exportJOB_RUN_TIME={{runtime}}{{prologue}}{%ifsrun%}{{srun}}{%endif%}{{cmd}}{{epilogue}}PackagesThis extension is composed of a Python package namedjupyterlab_server_timerfor the server extension and a NPM package namedjupyterlab-server-timerfor the frontend extension.RequirementsJupyterLab >= 4.0.0InstallTo install the extension, execute:pipinstalljupyterlab_server_timerUninstallTo remove the extension, execute:pipuninstalljupyterlab_server_timerTroubleshootIf 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 jupyterlab_server_timer directory# Install package in development modepipinstall-e".[test]"# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Server extension must be manually installed in develop modejupyterserverextensionenablejupyterlab_server_timer# 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 modejupyterserverextensiondisablejupyterlab_server_timer
pipuninstalljupyterlab_server_timerIn 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 namedjupyterlab-server-timerwithin that folder.Testing the extensionServer testsThis extension is usingPytestfor Python code testing.Install test dependencies (needed only once):pipinstall-e".[test]"# Each time you install the Python package, you need to restore the front-end extension linkjupyterlabextensiondevelop.--overwriteTo execute them, run:pytest-vv-rap--covjupyterlab_server_timerFrontend testsThis extension is usingJestfor JavaScript code testing.To execute them, execute:jlpm
jlpmtestIntegration testsThis extension usesPlaywrightfor the integration tests (aka user level tests).
More precisely, the JupyterLab helperGalatais used to handle testing the extension in JupyterLab.More information are provided within theui-testsREADME.Packaging the extensionSeeRELEASE