Skip to main content

Access remote files through a Jupyter server

Project description

jupyterlab-remote-contents

Browse 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.

Requirements

  • JupyterLab >= 4.0

Install

To install the extension, execute:

pip install jupyterlab-remote-contents

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab-remote-contents

Usage

Since remote contents are fetched from another origin than the client's, you may run into CORS issues. The Jupyter server serving the remote contents API must support the client's origin.

For instance, if you launch JupyterLab with:

jupyter lab --ServerApp.ip='127.0.0.1' --ServerApp.port=8888

Then you must pass --ServerApp.allow_origin='http://127.0.0.1:8888' to the Jupyter server serving the contents API:

jupyter server --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 at http://127.0.0.1:8000/" (instead of "not connected").

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlab-remote-contents directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build

You 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 needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

With 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, the jlpm build command 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:

jupyter lab build --minimize=False

Development uninstall

pip uninstall jupyterlab-remote-contents

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named jupyterlab-remote-contents within that folder.

Packaging the extension

See RELEASE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlab_remote_contents-0.1.1.tar.gz (52.3 MB view details)

Uploaded Source

Built Distribution

jupyterlab_remote_contents-0.1.1-py3-none-any.whl (30.6 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_remote_contents-0.1.1.tar.gz.

File metadata

File hashes

Hashes for jupyterlab_remote_contents-0.1.1.tar.gz
Algorithm Hash digest
SHA256 66980cbd7bcea527d6bbe71e34d974a680f21fd30a526f95d83007b2d283e161
MD5 6fce98fdad506d16d60e31e565665082
BLAKE2b-256 fe9079ff1c46a8fca195bd8272c4a34715d38dbf41471f42bd99f2242e0814a7

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlab_remote_contents-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlab_remote_contents-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b5265678849a0e39ae0a78cc3b9b2cf7a440ee5ec60a51c905021202d7526ec2
MD5 e375c2297db34cfba24af99136009340
BLAKE2b-256 a05a9923952787084ae376fccc310dc1a6b00af04934435840646c3e9c5c7e1f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page