Package: jp-noui
jp_nouiHides all jupyter UI elements leaving only cell outputs (notebooks are auto executed).Try it out onbinderhttps://user-images.githubusercontent.com/48299585/222978092-a3763fcf-2672-454a-b755-b8618d0de531.mp4RequirementsJupyterLab >= 3.0InstallTo install the extension, execute:pipinstalljp_nouiUninstallTo remove the extension, execute:pipuninstalljp_nouiConfigurationCreate aconfig.jsonfollowing the structure found inbinder/jupyter_config.jsonLaunch the server withjupyter-noui --config="path/to/config.json"(+ any other args you'd like to passjupyter lab... e.g.--no-browser)Tweaksplash.htmluntil satisfied (no need to restart the server, just refresh the page)seebinder/jupyter_config.jsonfor an example. Config options are expected to be found in ServerApp.tornado_settings.page_config_data.noui_splash_html: Path to html file to show until the notebook finishes execution.noui_style_css: Path to css stylesheet to alter the appearance of JupyterLab.noui_notebook: Path to notebook to open and execute on launch.While none of these options are required, ifnoui_notebookis missing, then every notebook will be auto-executed as soon as it is activated, and you'll need to do something to ensure the correct notebook is loaded, e.g. by addingtree/path/to/your/notebook.ipynbto the url used to launch the app.ContributingDevelopment 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 jp_noui directory# Install package in development modepipinstall-e"."# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# 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 uninstallpipuninstalljp_nouiIn 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 namedjp-nouiwithin that folder.Testing the extensionFrontend testsThis extension is usingJestfor JavaScript code testing.To execute them, execute:jlpm
jlpmtestIntegration testsThis extension uses Playwright for 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