jupyter-fs 1.1.2

A Filesystem-like mult-contents manager backend for Jupyter

A plugin for JupyterLab that lets you set up and use as many filebrowsers as you like, connected to whatever local and/or remote filesystem-like resources you want.

The backend is built on top of PyFilesystem and fsspec, while the frontend is built on top of tree-finder.

Install

pip install jupyter-fs

# To use with PyFilesystem2
# pip install jupyter-fs[fs]

# To use with fsspec
# pip install jupyter-fs[fsspec]

Configure

Add the following to your jupyter_server_config.json:

{
  "ServerApp": {
    "contents_manager_class": "jupyterfs.MetaManager",
    "jpserver_extensions": {
      "jupyterfs.extension": true
    }
  }
}

Resources can then be added via the Settings -> Settings Editor.

Simple use (no auth/credentials)

Add specifications for additional contents managers in your user settings (in the Settings menu under Advanced Settings Editor -> jupyter-fs). Here's an example config that sets up several new filebrowsers side-by-side:

{
  "resources": [
    {
      "name": "root at test dir",
      "url": "osfs:///Users/foo/test",
      "type": "pyfs"
    },
    {
      "name": "s3 test bucket",
      "url": "s3://test",
      "type": "pyfs"
    },
    {
      "name": "s3 test key",
      "url": "s3://test-2/prefix/",
      "type": "pyfs",
      "defaultWritable": false
    },
    {
      "name": "samba guest share",
      "url": "smb://guest@127.0.0.1/test?name-port=3669",
      "type": "pyfs"
    }
  ]
}

You should see your new filebrowsers pop up in the left-hand sidebar instantly when you save your settings:

Use with auth/credentials

Any stretch of a "url" that is enclosed in double-brackets {{VAR}} will be treated as a template, and will be handled by jupyter-fs's auth system. For example, you can pass a username/password to the "samba guest share" resource in the Simple use example above by modifying its "url" like so:

{
  "resources": [
    ...

    {
      "name": "samba share",
      "url": "smb://{{user}}:{{passwd}}@127.0.0.1/test?name-port=3669",
      "type": "pyfs"
    }
  ]
}

When you save the above "resouces" config, a dialog box will pop asking for the username and passwd values:

Once you enter those values and hit ok, the new filebrowsers will then immediately appear in the sidebar:

The auth dialog will only appear when needed

The jupyter-fs auth dialog will only appear when:

• JupyterLab first loads, if any fs resources require auth
• a new fs resouce is added that requires auth, or its "url" field is modified

[!NOTE] Additional options are overrideable via environment variables by most backends for PyFilesystem and fsspec

Supported filesystems

The type of resource each filebrowser will point to is determined by the protocol at the start of its url:

PyFilesystem

• osfs: os filesystem. The will open a new view of your local filesystem, with the specified root
• s3: opens a filesystem pointing to an Amazon S3 bucket
• smb: opens a filesystem pointing to a Samba share

jupyter-fs can open a filebrowser pointing to any of the diverse resources supported by PyFilesystem. Currently, we test only test the S3 and smb/samba backends as part of our CI, so your milleage may vary with the other PyFilesystem backends.

fsspec

• local / file: Local filesystem
• s3fs: S3 filesystem

jupyter-fs should also support any of the fsspec builtin or known backends.

In many cases, these will be customized via environment variables. As an example for s3fs, to customize the backend and auth:

export FSSPEC_S3_ENDPOINT_URL=<YOUR BACKEND>
export FSSPEC_S3_KEY=<YOUR KEY>
export FSSPEC_S3_SECRET=<YOUR SECRET>

Choosing the backend

Your resource can include a "type" field, set to either pyfs or fsspec. The default is pyfs. This field can be configured via JSON Settings or graphically.

The filesystem url

PyFilesystem

The "url" field jupyter-fs config is based on the PyFilesystem opener url standard. For more info on how to write these urls, see the documentation of the relevant PyFilesystem plugin:

• S3: S3FS docs
• smb: fs.smbfs docs

fsspec

Similar to PyFilesystem, fsspec also allows for a "url" based opening scheme as documented here.

Server-side settings

If you prefer to set up your filesystem resources in the server-side config, you can do so. For example, you can set up a local filesystem by adding the following to your jupyter_server_config.py file (or jupyter_lab_config.py or jupyter_notebook_config.py depending on your setup):

c.JupyterFs.resources = [
    {
        "name": "local_test",
        "url": "osfs:///Users/foo/test",
        "type": "pyfs"
    },
]

ALternatively, you can add resource specifications alongside the basic jupyter-fs config in your jupyter_server_config.json file:

{
  "ServerApp": {
    "contents_manager_class": "jupyterfs.metamanager.MetaManager",
    "jpserver_extensions": {
      "jupyterfs.extension": true
    }
  },
  "JupyterFs": {
    "resources": [
      {
        "name": "local_test",
        "url": "osfs:///Users/foo/test",
        "type": "pyfs"
      }
    ]
  }
}

Any filesystem resources specified in any server-side config file will be merged with the resources given in a user's settings.

Development

See CONTRIBUTING.md for guidelines.

License

This software is licensed under the Apache 2.0 license. See the LICENSE and AUTHORS files for details.