imjoy插件引擎,用于从imjoy.io本地或远程运行python插件
imjo的Python项目详细描述
ImJoy插件引擎
用于在ImJoy(https://imjoy.io)中运行python插件的插件引擎
安装(桌面应用)
如果要在桌面环境中使用插件引擎,请从here下载最新的ImJoy应用程序请按照不同操作系统的说明进行操作。
您将得到一个用于启动插件引擎的可执行文件。
安装(Linux服务器/群集)
要通过Linux主机上的命令行界面使用它,请在终端中运行此命令以安装插件引擎:
wget https://raw.githubusercontent.com/oeway/ImJoy-Engine/master/utils/Linux_Install.sh -O - | bash
注意:当您运行上面的脚本时,它将首先下载miniconda3并将其安装到$HOME/ImJoyApp
中,这可能会占用相当大的空间。如果要卸载它,请运行rm -rf $HOME/ImJoyApp
。
要启动插件引擎,请运行:
export PATH=~/ImJoyApp/bin:$PATH
imjoy --host=0.0.0.0 --port=9527 --serve
请注意,如果您试图使用远程服务器上运行的ImJoy插件引擎,请使用服务器上提供的ImJoy web应用程序(http://YOUR_REMOTE_IP:9527
),而不是https://imjoy.io
这是因为大多数浏览器不允许通过https
服务的web应用程序连接到不安全的服务器(远程服务器)。或者,您可以使用代理为插件引擎启用https
,然后您就可以将其与https://imjoy.io
一起使用。
手动安装
如果您处于以下情况:
- 已经有了Conda环境(Anaconda 3或Miniconda 3)
- 希望更好地控制安装过程
- 上面的安装有问题
请遵循以下手动安装方法:
如果您没有conda环境,请下载并安装Miniconda with Python 3.7(或者Anaconda with Python 3.7,如果您希望完全安装)
启动terminal(Mac和Linux)或anaconda提示符(Windows),然后运行以下命令:
conda -V && pip install -U imjoy
- 如果遇到与
git
或pip
相关的任何错误,请尝试在上述命令之前运行:conda install -y git pip
。(否则,请检查faq)
安装后使用:
在terminal或anaconda提示符下运行
imjoy
命令,并保持窗口运行。转到https://imjoy.io,连接到插件引擎。第一次,您将被要求填充由插件引擎从上一步生成的令牌。一旦连接,就可以开始通过插件引擎运行python插件
升级
通常,插件引擎在启动时会自动升级。 如果在启动或升级应用程序时遇到问题,请尝试在terminal(Mac和Linux)或anaconda prompt(Windows)中运行以下命令来手动升级应用程序:
PATH=~/ImJoyApp/bin:$PATH pip install -U imjoy
访问imjoy engine conda环境
如果使用ImJoyEngine安装插件引擎,它将在~/ImJoyApp
中设置miniconda环境。
要访问Linux和Mac上的环境,只需将~/ImJoyApp/bin
添加到$PATH
:
export PATH=~/ImJoyApp/bin:$PATH
# now you can use command such as `imjoy`, `conda`, `pip`, `python` provided from ~/ImJoyApp
imjoy
对于windows,可以使用powershell将ImJoyApp添加到$env.Path
:
$env:Path = '%systemdrive%%homepath%\ImJoyApp;%systemdrive%%homepath%\ImJoyApp\Library\bin;%systemdrive%%homepath%\ImJoyApp\Scripts;' + $env:Path;
# now you can use command such as `imjoy`, `conda`, `pip`, `python` provided from ~/ImJoyApp
imjoy
卸载/删除imjoy引擎
要卸载或删除imjoy引擎,需要删除位于主/用户文件夹中的两个文件夹:ImJoyApp
和ImJoyWorkspace
。
ImJoyApp
包含一个miniconda环境和用于运行imjoy插件的虚拟环境ImJoyWorkspace
包含每个ImJoy工作区的用户数据,您可能需要备份这些数据
在Linux/OSX上,您可以运行以下命令:
rm -rf $HOME/ImJoyApp
rm -rf $HOME/ImJoyWorkspace # please backup important data inside this folder
在windows上,它通常位于C:\Users\<CurrentUserName>
,您可以手动删除ImJoyApp
和ImJoyWorkspace
Docs
中的更多详细信息和常见问题解答路线图
您可以在这里跟踪项目进度:https://github.com/oeway/ImJoy/projects/2
错误报告和功能请求
请将您的问题提交给ImJoy/issues
开发
- 开发需要Python 3.6,因为我们使用^{
} 进行代码格式化
git clone git@github.com:oeway/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
不会更改任何文件