Package: jupyter-kernel-executor
jupyter_kernel_executorJupyter extension for http cell executeThis extension is composed of a Python package namedjupyter_kernel_executorfor the server extension and a NPM package namedjupyter_kernel_executorfor the frontend extension.(NPM package is not ready yet)RequirementsJupyterLab >= 3.0InstallTo install the extension, execute:pipinstalljupyter_kernel_executorIn Linux systems, it is common to useextor similar file systems, and through theinoattributes provided by such
file systems, we can track the movement of files.If your system meets these requirements, it is recommended that you also install jupyter_server_fileid and configure it
according tothis documentpipinstalljupyter_kernel_executor[fileid]UninstallTo remove the extension, execute:pipuninstalljupyter_kernel_executorTroubleshootIf 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:jupyterlabextensionlistContributingServer extension APIAPI docs in OpenAPI3, usingSwagger Editorcan view it onlineDevelopment 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 jupyter_kernel_executor 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 modejupyterserverextensionenablejupyter_kernel_executor# 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 modejupyterserverextensiondisablejupyter_kernel_executor
pipuninstalljupyter_kernel_executorIn 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 namedjupyter_kernel_executorwithin that folder.Testing the extensionServer testsThis extension is usingPytestfor Python code testing.Install test dependencies (needed only once):pipinstall-e".[test]"To execute them, run:pytest-vv-rap--covjupyter_kernel_executorFrontend 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