跳转到主要内容

一个用于渲染HoloViz内容的JupyterLab扩展。

项目描述

pyviz_comms

Github Actions Status

提供Python和JavaScript之间简单双向通信架构,支持经典笔记本和Jupyterlab中的Jupyter通信。任何PyViz工具都可以使用,但目前主要被HoloViz工具使用。

在这个存储库中有两个可安装组件:一个用于各种 HoloViz 工具的 Python 组件,以及一个扩展以支持 Jupyterlab。对于 JupyterLab 3.0 及以上版本,该扩展会自动与 pyviz_comms Python 包捆绑在一起。

安装 Jupyterlab 扩展

Jupyterlab 用户需要安装 Jupyterlab pyviz 扩展。从 JupyterLab 3.0 及以上版本开始,在用 pip 安装 pyviz_comms 时,扩展将自动安装。

pip install pyviz_comms

或使用 conda 进行安装

conda install -c pyviz pyviz_comms

对于旧版本的 JupyterLab,您必须单独安装

jupyter labextension install @pyviz/jupyterlab_pyviz

兼容性

Holoviz 库通常与 JupyterLab 的版本无关,并且从 holoviews 1.10.0 和 pyviz_comms 的首个版本开始,就支持了 jupyterlab_pyviz 扩展。

我们的目标是使 jupyterlab_pyviz 的次要版本(使用 SemVer 模式)遵循 JupyterLab 的次要版本更新,而微版本则是针对新的 jupyterlab_pyviz 功能或错误修复版本。我们之前在扩展次要版本更新与 JupyterLab 保持一致方面不够一致,因此寻求找到与其 JupyterLab 安装兼容的扩展版本的用户可以参考以下表格。

兼容的 JupyterLab 和 jupyterlab_pyviz 版本
JupyterLab jupyterlab_pyviz
0.33.x 0.6.0
0.34.x 0.6.1-0.6.2
0.35.x 0.6.3-0.7.2
1.0.x 0.8.0
2.0.x 0.9.0-1.0.3
3.x 2.0
4.x 3.0

开发 Jupyterlab 扩展

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

jlpm 命令是 JupyterLab 预装版本的 yarn,与 JupyterLab 一起安装。您可以使用 yarnnpm 替代以下内容中的 jlpm

# Clone the repo to your local environment
# Change directory to the holoviz_jlab 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 run build

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

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

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

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

jupyter lab build --minimize=False

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解更多关于 安装软件包 的信息。

源分发

pyviz_comms-3.0.3.tar.gz (196.5 kB 查看哈希值)

上传时间: 源代码

构建发行版

pyviz_comms-3.0.3-py3-none-any.whl (83.5 kB 查看哈希值)

上传时间: Python 3

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面