Skip to main content

A JupyterLab extension which enables client-side drives access.

Project description

jupyter-drives-browser

Github Actions Status A JupyterLab extension which enables client-side drives access.

Screenshot from 2024-05-06 15-22-59

The drives are used as a filesystem, having support for all basic functionalities (file tree-view, editing contents, copying, renaming, deleting, downloading etc).

The extension was built using the official JavaScript AWS SDK.

Drives Compatibility

Currently, the extension offers support only for S3 drives.

Configuration

Set CORS Rules

As the extension works in the browser, the S3 buckets need to have certain CORS (Cross-Origin-Resource-Sharing) rules set:

  • http://localhost:* needs to be added to the AllowedOrigins section,
  • GET, PUT, DELETE, HEAD need to be added to the AllowedMethods section.

More information about CORS here and the various ways to configure it here.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyter_drives_browser

Uninstall

To remove the extension, execute:

pip uninstall jupyter_drives_browser

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 jupyter_drives_browser 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 jupyter_drives_browser

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 jupyter-drives-browser within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

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

jupyter_drives_browser-0.1.0a0.tar.gz (278.5 kB view details)

Uploaded Source

Built Distribution

jupyter_drives_browser-0.1.0a0-py3-none-any.whl (136.1 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_drives_browser-0.1.0a0.tar.gz.

File metadata

File hashes

Hashes for jupyter_drives_browser-0.1.0a0.tar.gz
Algorithm Hash digest
SHA256 d885570a20234ae65fec69ebe44194fd9aa73d61afe20456acbb37c9f488960f
MD5 914034da377ecab224f32b8122ed8d4e
BLAKE2b-256 37d8aa73e5a6fdbe8cbfb059649bff1b3ec2b2ebc5e69c85acd161b88555f170

See more details on using hashes here.

File details

Details for the file jupyter_drives_browser-0.1.0a0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_drives_browser-0.1.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee51246dbd4dea69b031f64baa74869d0ec0bc585bcdfeda523d36841aeaf682
MD5 0eae283859a5484c66559fe211dd62f7
BLAKE2b-256 8abe703c5c28be4d87f8f9510c647d568436b361718901abdeca5838720a5bc6

See more details on using hashes here.

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