跳转到主要内容

Voila扩展

项目描述

voila_topbar

Github Actions Status

vl3

voila_topbar 是一个Voila扩展,它为仪表板和树页面添加了顶部栏。顶部栏可以包含一个标志、一个标题、一个主题选择器和内核状态指示器。

要配置顶部栏,您可以使用以下内容的 voila.json 文件

// voila.json
{
  "VoilaConfiguration": {
    "extension_config": {
      "voila_topbar": {
        "background": "red",
        "textColor": "blue",
        "title": "My title",
        "icon": "link-to-the-icon-file",
        "kernelActivity": true,
        "themeToggle": true
      }
    }
  }
}

要求

  • JupyterLab >= 4.0.0

安装

要安装扩展,请执行

pip install voila_topbar

卸载

要删除扩展,请执行

pip uninstall voila_topbar

贡献

开发安装

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

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

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

在开发模式下,您还需要删除由jupyter labextension develop命令创建的符号链接。要找到其位置,您可以通过运行jupyter labextension list来弄清楚labextensions文件夹的位置。然后您可以在该文件夹中删除名为voila_topbar的符号链接。

打包扩展

RELEASE

项目详情


下载文件

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

源分布

voila_topbar-0.1.1.tar.gz (169.5 kB 查看哈希)

上传时间

构建分布

voila_topbar-0.1.1-py3-none-any.whl (733.1 kB 查看哈希)

上传时间 Python 3

由...