Package: jupyterlab-remote-contents
jupyterlab-remote-contentsBrowse remote files using the Jupyter contents API. This is the default for JupyterLab, but not for JupyterLite
which uses the browser's local storage. This extension allows to access remote files served by a Jupyter server.RequirementsJupyterLab >= 4.0InstallTo install the extension, execute:pipinstalljupyterlab-remote-contentsUninstallTo remove the extension, execute:pipuninstalljupyterlab-remote-contentsUsageSince remote contents are fetched from another origin than the client's, you may run intoCORSissues.
The Jupyter server serving the remote contents API must support the client's origin.For instance, if you launch JupyterLab with:jupyterlab--ServerApp.ip='127.0.0.1'--ServerApp.port=8888Then you must pass--ServerApp.allow_origin='http://127.0.0.1:8888'to the Jupyter server serving the contents API:jupyterserver--ServerApp.ip='127.0.0.1'--ServerApp.port=8000--ServerApp.allow_origin='http://127.0.0.1:8888'In JupyterLab, click on the list icon "Remote Contents (not connected)" on the left panel, then click on the folder icon "Connect to Jupyter Server".
You should be prompted to enter the Jupyter server URL. Enter e.g. "http://127.0.0.1:8000/?token=87b..." (don't forget the token if you have one). If you hover over the icon on the left panel, you should now see something like "Remote Contents athttp://127.0.0.1:8000/" (instead of "not connected").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 jupyterlab-remote-contents 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 uninstallpipuninstalljupyterlab-remote-contentsIn 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-remote-contentswithin that folder.Packaging the extensionSeeRELEASE