ImJoy Plugin Engine for running Python plugins locally or remotely from ImJoy.io
Project description
ImJoy Plugin Engine
The plugin engine used for running python plugins in ImJoy (https://imjoy.io).
Installation (Desktop App)
If you want to use the plugin engine from a desktop environment, download the latest ImJoy-App from here. Follow the instructions according to different operating systems.
You will get an executable file for starting the Plugin Engine.
Installation (Linux servers/clusters)
For using it through a command line interface on a Linux host, run this command in your terminal to install the plugin engine:
wget https://raw.githubusercontent.com/oeway/ImJoy-Engine/master/utils/Linux_Install.sh -O - | bash
NOTE: When you run the script above, it will first download and install Miniconda3 into $HOME/ImJoyApp, it may take considerably amount of space. If you want to uninstall it, run rm -rf $HOME/ImJoyApp.
To start the plugin engine, run:
export PATH=~/ImJoyApp/bin:$PATH
imjoy --host=0.0.0.0 --port=9527 --serve
Please notice that if you are trying to use ImJoy Plugin Engine running on a remote server, please use the ImJoy web App served on your server (http://YOUR_REMOTE_IP:9527) instead of https://imjoy.io. This is because most browser do not allow a web application served throught https to connect to a unsecured server (your remote server). Alternatively, you use proxy to enable https for the plugin engine, then you will be able to use it with https://imjoy.io.
Manual Installation
If you are in the following situation:
- already have a conda environemnt (Anaconda 3 or Miniconda 3)
- want better control over the installation process
- having trouble with the installation above
Please follow the manual installation method below:
-
If you don't have a conda environemnt, download and install Miniconda with Python 3.7 (or Anaconda with Python 3.7 if you prefer a full installation).
-
Start a Terminal(Mac and Linux) or Anaconda Prompt(Windows), then run the following command:
conda -V && pip install -U imjoy
- If you encountered any error related to
gitorpip, try to run :conda install -y git pipbefore the above command. (Otherwise, please check FAQs.)
To use it after the installation:
-
Run
imjoycommand in a Terminal or Anaconda Prompt, and keep the window running. -
Go to https://imjoy.io, connect to the plugin engine. For the first time, you will be asked to fill a token generated by the plugin engine from the previous step. Once connected, you can start to run python plugin through the plugin engine.
Upgrading
Normally, the Plugin Engine will upgrade itself when it starts. In case you have problem with starting or upgrading the App, try to manually upgrade it by running the following command in a Terminal(Mac and Linux) or Anaconda Prompt(Windows):
PATH=~/ImJoyApp/bin:$PATH pip install -U imjoy
Accessing the ImJoy Engine Conda environment
If you installed the Plugin Engine with the ImJoyEngine, it will setup an Miniconda environment located in ~/ImJoyApp.
To access the environment on Linux and Mac, you just need to add ~/ImJoyApp/bin to your $PATH:
export PATH=~/ImJoyApp/bin:$PATH
# now you can use command such as `imjoy`, `conda`, `pip`, `python` provided from ~/ImJoyApp
imjoy
For windows, you can use powershell to add the ImJoyApp to $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
Uninstall/remove ImJoy Engine
In order to uninstall or remove ImJoy Engine, you need to remove two folders located in your home/user folder: ImJoyApp and ImJoyWorkspace.
ImJoyAppcontains a Miniconda environemnt and the virtual environemtns used for running ImJoy pluginsImJoyWorkspacecontains user data for each ImJoy workspace, you may want to backup the data.
On Linux/OSX, you can run the following command:
rm -rf $HOME/ImJoyApp
rm -rf $HOME/ImJoyWorkspace # please backup important data inside this folder
On windows, it's typically located in C:\Users\<CurrentUserName>, you can remove ImJoyApp and ImJoyWorkspace manually.
More details and FAQs in Docs
Roadmap
You can track the progress of the project here: https://github.com/oeway/ImJoy/projects/2
Bug report and feature request
Please submit your issue to ImJoy/issues
Development
- Development requires Python 3.6, since we use
blackfor code formatting.
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
- Run
toxto run all tests and lint, including checking thatblackdoesn't change any files.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file imjoy-0.7.66.tar.gz.
File metadata
- Download URL: imjoy-0.7.66.tar.gz
- Upload date:
- Size: 41.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.25.0 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f0d99fd63200fafa7b44af91b90daab0861b35b84df0e7ba68b48be4b1e0401f |
|
| MD5 | 286c0db0e22680adaf8d06de5cea600f |
|
| BLAKE2b-256 | 207b251c2594ca436cc3896648b6817f5201486decc5d65470743f91f9e8155b |
File details
Details for the file imjoy-0.7.66-py3-none-any.whl.
File metadata
- Download URL: imjoy-0.7.66-py3-none-any.whl
- Upload date:
- Size: 44.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.25.0 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d23a47dc7c11fbb7e7551d451a0b0c359e92272ffdce788eae72f398ecb53c54 |
|
| MD5 | f8d7a3df2661ebe775441dcec3106b3e |
|
| BLAKE2b-256 | 9db03c1dd47dc43e3d7f66ae6193d9a4a72827f103247d78bbc6c4ff73149ed1 |
