跳转到主要内容

ImJoy插件引擎,用于在ImJoy.io上本地或远程运行Python插件

项目描述

ENGINE_VERSION PyPI GitHub Build Status ImJoy Version

ImJoy插件引擎

ImJoy中运行python插件的插件引擎 (https://imjoy.io)。

这个库主要基于jupyter notebook服务器,增加了额外的库和方便的设置。

安装

  • 如果您没有conda环境,请下载并安装带有Python 3.7的Miniconda(或者如果您更喜欢完整安装,请安装Anaconda)。

  • 在Mac和Linux上启动一个终端,或者在Windows上启动一个Anaconda Prompt,然后运行以下命令

pip install -U imjoy[jupyter]

上面的命令还将安装jupyter notebook和imjoy-elfinder

  • 如果您遇到任何与gitpip相关的错误,请在上述命令之前运行:conda install -y git pip。(否则,请检查常见问题解答。)

用法

安装后使用

  • 在终端或Anaconda Prompt中运行imjoy --jupyter命令,并保持窗口运行。您将从终端获得一个类似http://localhost:8888/?token=caac2d7f2e8e0...ad871fe的链接,请复制它用于下一步。

  • 转到https://imjoy.io,点击右上角的🚀图标,选择添加Jupyter-Engine,粘贴您之前获得的链接,并连接到插件引擎。一旦连接,您就可以通过插件引擎运行python插件了。

请注意,如果您正在尝试使用运行在远程服务器上的ImJoy插件引擎,请使用您服务器上提供的ImJoy Web应用程序(http://YOUR_REMOTE_IP:9527),而不是使用https://imjoy.io。这是因为大多数浏览器都不允许通过https提供的Web应用程序连接到未加密的服务器(您的远程服务器)。作为替代方案,您可以使用代理来为插件引擎启用https。这样,您就可以使用https://imjoy.io来访问它。

连接到ImJoy引擎服务器

import webbrowser
from imjoy_rpc import connect_to_server, launch_plugin

def new_client_join(ws):
    viewer = await ws.createWindow(src="https://kaibu.org")

async def main():
    api = await connect_to_server(server_url="https://api.imjoy.io/")
    api.on('join', new_client_join)
    tk = await api.generate_token()
    name = api.config['name']
    token = tk['token']
    url = f"https://imjoy.io/lite?server_url=https://api.imjoy.io&token={token}&name={name}"
    print(url)
    webbrowser.open(url)

更多详细信息和其他常见问题解答请参阅文档

路线图

您可以在以下链接跟踪项目的进展:https://github.com/imjoy-team/ImJoy/projects/2

问题

请将您的错误报告或功能请求提交到ImJoy/issues

开发

  • 我们使用black进行代码格式化。
  git clone git@github.com:imjoy-team/ImJoy-Engine.git
  # Enter directory.
  cd ImJoy-Engine
  # Install all development requirements and package in development mode.
  pip3 install -r requirements_dev.txt
  • 运行tox以运行所有测试和lint,包括检查black是否更改了任何文件。

项目详情


发布历史 发布通知 | RSS源

下载文件

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

源分发

imjoy-0.11.20.tar.gz (55.2 kB 查看哈希值)

上传时间:

构建分发

imjoy-0.11.20-py3-none-any.whl (66.6 kB 查看哈希值)

上传时间: Python 3

由以下机构支持