Package: etc-jupyterlab-notebook-state-provider
ETC JupyterLab Notebook State ProviderThe ETC JupyterLab Notebook State Provider produces sequential diffs of Notebooks.  Each call toETCJupyterLabNotebookStateProvider#getNotebookStateproduces a representation of the Notebook where cells that are unchanged since the last call contain just their IDs.  Cells that have not changed since the last call contain their unaltered content.  The diffs can be used in order to reconstruct the Notebook at each point in the sequence.This strategy allows for the state of the Notebook to captured at many points while reducing the amount of storage and network resources needed in order to store the Notebooks.UsageIn the below minimal example, a NotbookPanel is registered with theETCJupyterLabNotebookStateProvider.  The call togetNotebookStatereturns an object that contains a session ID, sequence number, and a serializable representation of the Notebook.  Each subsequent call togetNotebookStatewill return a representation of the Notebook where cells that are unchanged since the last call contain just their IDs.  Cells that have not changed since the last call contain their unaltered content.constplugin:JupyterFrontEndPlugin<void>={id:'PLUGIN_ID',autoStart:true,requires:[INotebookTracker,IETCJupyterLabNotebookStateProvider],activate:(app:JupyterFrontEnd,notebookTracker:INotebookTracker,etcJupyterLabNotebookStateProvider:IETCJupyterLabNotebookStateProvider)=>{notebookTracker.widgetAdded.connect(async(sender:INotebookTracker,notebookPanel:NotebookPanel)=>{etcJupyterLabNotebookStateProvider.addNotebookPanel({notebookPanel});letnotebookState=etcJupyterLabNotebookStateProvider.getNotebookState({notebookPanel});console.log(notebookState);});}};RequirementsJupyterLab >= 3.0InstallTo install the extension, execute:pipinstalletc_jupyterlab_notebook_state_providerUninstallTo remove the extension, execute:pipuninstalletc_jupyterlab_notebook_state_providerTroubleshootIf 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 etc_jupyterlab_notebook_state_provider 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 modejupyterserverextensionenableetc_jupyterlab_notebook_state_provider# 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 modejupyterserverextensiondisableetc_jupyterlab_notebook_state_provider
pipuninstalletc_jupyterlab_notebook_state_providerIn 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 named@educational-technology-collective/etc_jupyterlab_notebook_state_providerwithin that folder.Packaging the extensionSeeRELEASE