jupyter-fs
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, while the frontend is built on top of JupyterLab Filetree.
Install
pip install jupyter-fs
Configure
Add the following to your jupyter_notebook_config.json:
{
"NotebookApp": {
"contents_manager_class": "jupyterfs.metamanager.MetaManager",
"nbserver_extensions": {
"jupyterfs": true
}
}
}
Use
Add specifications for additional contents managers in your user settings (in the Settings menu under Advanced Settings Editor -> jupyter-fs). Here's an example of how to set up two new views of the local filesystem:
{
"specs": [
{
"name": "local_test",
"url": "osfs:///Users/foo/test"
},
{
"name": "local_jupyter-fs_repo",
"url": "osfs:///Users/foo/git/jupyter-fs"
}
]
}
where osfs stands for os filesystem. You should see your new filebrowser pop up in the left-hand sidebar instantly when you save your settings:
PyFilesystem urls
"url" is a PyFilesystem opener url. For more info on how to write these urls, see the documentation of the relevant PyFilesystem plugin:
- S3: S3FS docs
- smb: fs.smbfs docs
(EXPERIMENTAL) Adding remote filesystems
Not recommended for production use: currently requires saving your credentials in plaintext
jupyter-fs also supports a wide variety of remote filesystem-like resources. Currently, only S3 and smb/samba are confirmed to work/part of the test suite. In theory, any resource supported by PyFilesystem should be supported by jupyter-fs as well.
You can set up all of these different resources side-by-side:
{
"specs": [
{
"name": "osfs_jupyter-fs_repo",
"url": "osfs:///Users/foo/git/jupyter-fs"
},
{
"name": "s3_foo",
"url": "s3://username:passwd@foo?endpoint_url=http://127.0.0.1:9000"
},
{
"name": "smb_test",
"url": "smb://username:passwd@127.0.0.1/test?name-port=3669"
}
]
}
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_notebook_config.py:
c.jupyterfs.specs = [
{
"name": "local_test",
"url": "osfs:///Users/foo/test"
},
]
Any filesystem specs given in the server-side config will be merged with the specs 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.
Metadata
Release files for jupyter-fs 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| jupyter-fs-0.0.2.tar.gz | 386.2 kB | Without provenance | Details for jupyter-fs-0.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| jupyter_fs-0.0.2-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for jupyter_fs-0.0.2-py2.py3-none-any.whl |
Total release size: 472.6 kB
Release files / jupyter-fs-0.0.2.tar.gz
| Download URL | jupyter-fs-0.0.2.tar.gz |
|---|---|
| Size | 386.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
03f251d2d6f59a0f9be7ca6de45656f7bfd1a9994d519e16a09808d6d84be1b1
|
|
BLAKE2b-256 checksum How to use checksums |
0d266355710123515d22813f7a5b66c8a3011644ebc6fccc4b510dfdb79afff6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.6
|
Release files / jupyter_fs-0.0.2-py2.py3-none-any.whl
| Download URL | jupyter_fs-0.0.2-py2.py3-none-any.whl |
|---|---|
| Size | 86.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
d3434aeffa9924a7439410c0da7ec006448be2a9aa34710ad9f8f8c62afd3f62
|
|
BLAKE2b-256 checksum How to use checksums |
13bddc3f2110b155c698a17062d1bb38f032af52c7faaeb19f11101255c85324
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.6
|
Security for jupyter-fs 0.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.