Package: jupyterlab-kernel-usage
JupyterLab Kernel UsageAdvance notice: this extension is being contributed upstream; future versions will be published underjupyter-server/jupyter-resource-usage.This is an extension forJupyterLabto get kernel usage in a sidebar.This extension is composed of a Python package namedjupyterlab_kernel_usagefor the server extension and a NPM package namedjupyterlab-kernel-usagefor the frontend extension.RequirementsThis usage is only show for IPython kernels withipykernel>= 6.11.0.ContributingDevelopUse the providedenvironment.yamlto install the conda environment.conda deactivate && \
  make env-rm && \
  make env
conda activate jupyterlab-kernel-usage# Install the server and frontend in dev mode.makeinstall-dev# In terminal 1, Start the jupyterlab.# open http://localhost:8234?token=...makejlab# In terminal 2, start the extension building in watch mode.makewatchWhen making changes to the extension you will need to issue ajupyter labextension build, or, startjlpm run watchin the root of the repository to rebuild on every changes. You do not need to restart or rebuild JupyterLab for changes on the frontend extensions, but do need to restart the server for changes to the Python code.Development 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_kernel_usage 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 modejupyterserverextensionenablejupyterlab_kernel_usage# 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=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisablejupyterlab_kernel_usage
pipuninstalljupyterlab_kernel_usageIn 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_kernel_usagewithin that folder.RequirementsJupyterLab >= 3.0InstallTo install the extension, execute:pipinstalljupyterlab_kernel_usageUninstallTo remove the extension, execute:pipuninstalljupyterlab_kernel_usageTroubleshootIf 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:jupyterlabextensionlistPackaging the extensionSeeRELEASE