跳转到主要内容

JupyterLab扩展,使客户端能够访问驱动器。

项目描述

jupyter-drives-browser

Github Actions Status JupyterLab扩展,使客户端能够访问驱动器。

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

驱动器作为文件系统使用,支持所有基本功能(文件树视图、编辑内容、复制、重命名、删除、下载等)。

该扩展使用官方JavaScript AWS SDK 构建。

驱动器兼容性

目前,该扩展仅支持 S3 驱动器。

配置

设置CORS规则

由于扩展在浏览器中运行,S3存储桶需要设置某些CORS(跨源资源共享)规则

  • 需要将 http://localhost:* 添加到 AllowedOrigins 部分,
  • 需要将 GETPUTDELETEHEAD 添加到 AllowedMethods 部分。

更多关于CORS的信息,请参阅这里,以及配置它的各种方法这里

要求

  • JupyterLab >= 4.0.0

安装

要安装扩展,请执行

pip install jupyter_drives_browser

卸载

要删除扩展,请执行

pip uninstall jupyter_drives_browser

贡献

开发安装

注意:您需要NodeJS来构建扩展包。

jlpm命令是JupyterLab附带安装的yarn的固定版本。您可以使用yarnnpm代替下面的jlpm

# 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

您可以在不同的终端中同时监视源目录并运行JupyterLab,以监视扩展源的变化并自动重建扩展。

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

当监视命令运行时,每个保存的更改将立即在本地构建并可用于您正在运行的JupyterLab。刷新JupyterLab以在浏览器中加载更改(您可能需要等待几秒钟以重建扩展)。

默认情况下,jlpm build命令为该扩展生成源映射,以便更容易使用浏览器开发者工具进行调试。要为JupyterLab核心扩展也生成源映射,可以运行以下命令

jupyter lab build --minimize=False

开发卸载

pip uninstall jupyter_drives_browser

在开发模式下,您还需要删除由jupyter labextension develop命令创建的符号链接。要找到其位置,可以运行jupyter labextension list以确定labextensions文件夹的位置。然后您可以在该文件夹中删除名为jupyter-drives-browser的符号链接。

测试扩展

前端测试

此扩展使用Jest进行JavaScript代码测试。

要执行它们,请执行

jlpm
jlpm test

集成测试

此扩展使用Playwright进行集成测试(也称为用户级测试)。更准确地说,JupyterLab辅助程序Galata用于处理在JupyterLab中对扩展的测试。

更多信息请参阅ui-tests的README。

打包扩展

请参阅RELEASE

项目详情


下载文件

下载适合您平台的应用程序。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分布

jupyter_drives_browser-0.1.0a0.tar.gz (278.5 kB 查看哈希)

上传时间

构建发行版

jupyter_drives_browser-0.1.0a0-py3-none-any.whl (136.1 kB 查看哈希)

上传时间 Python 3

由以下机构支持