Jupyter的类似文件系统的multcontents manager后端
jupyter-fs的Python项目详细描述
^{1}$ 在
一个用于JupyterLab的插件,允许您设置和使用任意数量的文件浏览器,连接到任何本地和/或远程文件系统之类的资源。在
后端构建在PyFilesystem之上,而前端构建在JupyterLab Filetree之上。在
安装
pip install jupyter-fs
配置
将以下内容添加到您的jupyter_notebook_config.json
:
简单使用(无授权/凭据)
在用户设置中(在settings菜单中的Advanced settings编辑器->;jupyter fs下)添加其他内容管理器的规范。下面是一个同时设置多个新文件浏览器的配置示例:
{"resources":[{"name":"root at test dir","url":"osfs:///Users/foo/test"},{"name":"s3 test bucket","url":"s3://test"},{"name":"samba guest share","url":"smb://guest@127.0.0.1/test?name-port=3669"}]}
当您保存设置时,您应该会立即在左侧边栏中看到新的文件浏览器弹出:
与身份验证/凭据一起使用
任何包含在双括号{{VAR}}
中的"url"
将被视为模板,并将由jupyter fs的auth系统处理。例如,您可以将用户名/密码传递给上面的Simple use
示例中的"samba guest share"
资源,方法是修改其"url"
,如下所示:
{"resources":[...{"name":"samba share","url":"smb://{{user}}:{{passwd}}@127.0.0.1/test?name-port=3669"}]}
保存上述"resouces"
配置时,将弹出一个对话框,要求输入username
和{
输入这些值并单击“确定”后,新的文件浏览器将立即出现在侧栏中:
只有在需要时才会出现“验证”对话框
jupyter fs auth对话框仅在以下情况下出现:
- JupyterLab首先加载,如果有任何fs resources require auth
- 添加一个需要auth的新fs资源,或者修改其
"url"
字段
支持的文件系统
每个filebrowser指向的资源类型由其url开头的协议决定:
- ^{str{str}1{str^>系统{/str}。将使用指定的根打开本地文件系统的新视图
- s3:打开指向amazons3存储桶的文件系统
- smb:打开指向Samba共享的文件系统
jupyter fs可以打开指向任何不同的resources supported by PyFilesystem的文件浏览器。目前,我们只测试S3和smb/samba后端作为CI的一部分,因此您的milleage可能与其他PyFilesystem后端不同。在
文件系统url
jupyter fs config的"url"
字段基于PyFilesystemopener url标准。有关如何编写这些url的更多信息,请参阅相关PyFilesystem插件的文档:
- S3:S3FS docs
- 中小企业:fs.smbfs docs
服务器端设置
如果您希望在服务器端配置中设置文件系统资源,可以这样做。例如,您可以通过将以下内容添加到jupyter_notebook_config.py
文件来设置本地文件系统:
c.jupyterfs.resources=[{"name":"local_test","url":"osfs:///Users/foo/test"},]
或者,您可以在jupyter_notebook_config.json
文件中的基本jupyter fs config旁边添加资源规范:
{"NotebookApp":{"contents_manager_class":"jupyterfs.metamanager.MetaManager","nbserver_extensions":{"jupyterfs.extension":true}},"jupyterfs":{"resources":[{"name":"local_test","url":"osfs:///Users/foo/test"},]}}
任何服务器端配置文件中指定的任何文件系统资源都将与用户设置中给定的资源合并。在
发展
请参阅CONTRIBUTING.md以获取指南。在
许可证
此软件是在Apache2.0许可下授权的。见 LICENSE和AUTHORS文件以获取详细信息。在
- 项目
标签: