Repolode
Submit
jpmorganchase

jpmorganchase/jupyter-fs

A JupyterLab extension that adds multiple file browsers connected to local and remote storage such as S3 and Samba shares.

View on GitHub
Stars
249
Forks
57
Open issues
32
Last commit
6 days ago

What is it?

jupyter-fs is a JupyterLab plugin that lets you configure as many file browser panels as you need, each pointing to a local directory or a remote filesystem-like resource. Instead of being limited to the single working directory of a Jupyter server, you can see and work with several storage locations side by side in the sidebar.

The server side is built on PyFilesystem and fsspec, so resources are described by URLs such as osfs:// for local directories, s3:// for Amazon S3 buckets, and smb:// for Samba shares. Resources can be added through the JupyterLab settings editor or defined in server-side config files, and they are merged with user settings. Credentials can be templated in URLs with {{VAR}} placeholders, which triggers a prompt in JupyterLab when needed.

The frontend uses tree-finder. The project is installable from PyPI and npm, and the README notes that CI tests the S3 and Samba backends specifically, with other PyFilesystem and fsspec backends expected to work but less verified.

Key features

  • 01Adds multiple independent file browser panels in the JupyterLab sidebar.
  • 02Connects to local directories, Amazon S3 buckets, and Samba shares.
  • 03Supports both PyFilesystem and fsspec backends, selectable per resource.
  • 04Templates credentials in URLs and prompts for them when resources load.
  • 05Configurable through the JupyterLab settings editor or server-side config files.

Use cases

  • Browsing a shared network drive or Samba share from within a notebook environment.
  • Working with data stored in S3 buckets alongside local project files.
  • Giving a team access to several shared storage locations in one JupyterLab session.

Quick start

  1. 1

    Install the package with pip

    pip install jupyter-fs
  2. 2

    Add the MetaManager and extension settings to jupyter_server_config.json

  3. 3

    Add filesystem resources in JupyterLab via Settings -> Settings Editor

Things to know

  • Only the S3 and Samba (smb) PyFilesystem backends are tested in CI; other backends may not work as expected.
  • Authentication for remote resources relies on templated URLs and environment variables, which requires manual configuration.

Topics

#jupyter#jupyterlab#file-browser#s3#samba#fsspec#pyfilesystem#jupyter-lab#jupyter-notebook#jupyterlab-extension

FAQ

What is jupyter-fs?
A JupyterLab extension that adds multiple file browsers connected to local and remote storage such as S3 and Samba shares. jupyter-fs is a JupyterLab plugin that lets you configure as many file browser panels as you need, each pointing to a local directory or a remote filesystem-like resource. Instead of being limited to the single working directory of a Jupyter server, you can see and work with several storage locations side by side in the sidebar.
Is jupyter-fs free to use? What license does it have?
jupyter-fs is open source under the Apache-2.0 license. Check the license terms before using it in commercial products.
Is jupyter-fs still maintained?
Actively maintained. The last commit to jupyter-fs was on Oct 31, 2026.
What can I use jupyter-fs for?
Browsing a shared network drive or Samba share from within a notebook environment. Working with data stored in S3 buckets alongside local project files. Giving a team access to several shared storage locations in one JupyterLab session.
How do I install jupyter-fs?
Install the package with pip: pip install jupyter-fs Add the MetaManager and extension settings to jupyter_server_config.json Add filesystem resources in JupyterLab via Settings -> Settings Editor
Where can I get jupyter-fs?
The source code and installation instructions are on GitHub: https://github.com/jpmorganchase/jupyter-fs

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects