Package: jupyterlab-rtc-hub-settings
jupyterlab_rtc_hub_settingsA JupyterLab extension to manage real time collaboration settings on JupyterHubThis extension is composed of a Python package namedjupyterlab_rtc_hub_settingsfor the server extension and a NPM package namedjupyterlab_rtc_hub_settingsfor the frontend extension.The extension only works with specifically configured JupyterHub (>2.0, requires RBAC). The extension assumes that JupyterHub spawner passed the JupyterHub API key to the environment variableJUPYTERHUB_API_TOKENwith a scopeall, e.g.{'name':'server','scopes':['all'],}Also, the extension assumes that sharing groups and roles have been created for each JupyterHub user with the following names:Empty groupserver_sharing_{user}: keeps the list of all users with which I'm sharing my Jupyter server. This is the group that you will see and modify in the extension. Members of the group will have a box checked next to their nameGroup editing roleserver_sharing_{user}_group_editing_role. This roles allows extension to modify the above group on behalf of the user{
    'name': f'server_sharing_{user}_group_editing_role',
    'description': f'Edit server_sharing_{user} group',
    'scopes': [f'groups!group=server_sharing_{user}'],
    'users': [f'{user}']
}Sharing roleserver_sharing_{user}_role. Strictly speaking is not required for the extension to work, but is enabling the server access for users specified inserver_sharing_{user}The example JupyterHub configuration will be provided soon.RequirementsJupyterLab >= 3.0InstallTo install the extension, execute:pipinstalljupyterlab-rtc-hub-settingsUninstallTo remove the extension, execute:pipuninstalljupyterlab-rtc-hub-settingsTroubleshootIf 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_rtc_hub_settings 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_rtc_hub_settings# 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_rtc_hub_settings
pipuninstalljupyterlab-rtc-hub-settingsIn 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_rtc_hub_settingswithin that folder.Packaging the extensionSeeRELEASE