jyg

demo	docs	install	build

从CLI、REST API或其他浏览器窗口运行Jupyter浏览器客户端命令

有关完整文档，请参阅ReadTheDocs上的文档。

安装

注意：在安装浏览器和服务器扩展后，您需要重启服务器和/或刷新Jupyter客户端浏览器会话。

先决条件

• python >=3.8
• jupyterlab >=3

pip

pip install jyg jupyterlab

mamba

mamba install -c conda-forge jyg jupyterlab

... 或者如果您必须，请使用conda。

开发安装

有关开发安装，请参阅贡献指南。

快速入门

在运行上述任何内容之前，请确保您已为您的Jupyter客户端和服务器安装了 jyg扩展。

浏览器

• 在高级设置：命令板中
  • 创建一个新的板，模板如下

    <button data-command-id="help:licenses">Show Licenses</button>
    

  • 或更复杂

    <button
      data-command-id="apputils:change-theme"
      data-command-args='{"theme": "JupyterLab Dark"}'
    >
      Set theme
    </button>
    

• 点击板的启动项
  • 或者使用命令面板
• 点击板中的元素

CLI

列出命令

jyg list --json
jyg ls
jyg l

运行命令

以下都是等效的

jyg run filebrowser:open '{"path": "Untitled.ipynb"}'
jyg run filebrowser:open --path=Untitled.ipynb
jyg r filebrowser:open --path Untitled.ipynb

REST API

列出命令

GET http://localhost:8888/jyg/commands

  {
    "apps": [
      {
        "url": "http://localhost:8888"
      }
    ]
  }

运行一个命令

POST http://localhost:8888/jyg/command/docmanager:open

  {
    "path": "Untitled.ipynb"
  }

故障排除

如果各种部件看起来不起作用，请尝试以下步骤。

验证安装

jupyter server extension list
jupyter serverextension list

您应该看到一些包含以下内容的输出

jyg enabled
  - Validating jyg...
    jyg x.x.x OK

如果不存在，您可能可以使用以下方法重新启用它：

jupyter server extension enable --sys-prefix --py jyg
jupyter serverextension enable --sys-prefix --py jyg.serverextension

jupyter labextension list

您应该看到类似以下内容：

@deathbeds/jyg vx.x.x enabled OK

验证服务器正在运行

确保服务器正在运行。

jupyter server list
jupyter notebook list

验证浏览器应用程序正在运行

要运行或列出命令，浏览器必须运行客户端。同时，查看浏览器控制台（通常使用f12显示）以查找任何明确的错误或警告。

常见问题解答

jyg与Jupyter notebook<7兼容吗？

部分兼容。 jyg可以在作为notebook服务器扩展运行的JupyterLab派生应用程序中列出和运行命令...但仅当在jupyter_server<2下运行时。

它不能（也不会）与Bootstrap/jQuery笔记本UI集成，因为命令有一致的设计模式。

jyg与Jupyter notebook>=7兼容吗？

目前还不兼容。但发布后可能很快就会工作。

jyg与jupyter_server以外的后端兼容吗？

不兼容。除了上述关于notebook<7的内容之外。然而，API经过了广泛的类型化和测试，可以实现在另一个后端。

$MY_APPLICATION可以使用jyg驱动Jupyter客户端吗？

可能不行。开箱即用。jyg只为在协同部署的<iframe>中作为命令板操作其宿主应用提供了方法，并且只有在板子活跃运行时才会运行postMessage服务器。

然而，浏览器API是可用的，可以创建自定义扩展，这将允许一个已经可以访问Jupyter应用程序的网页注册使用postMessage。

如果您的应用程序已经控制了Jupyter应用程序，您可能可以使用到Application实例的句柄，获取对IWindowProxy插件的访问权，并将宿主窗口添加为源。