Skip to main content

ImJoy Plugin Engine for running Python plugins locally or remotely from

Project description

ENGINE_VERSION PyPI GitHub Build Status ImJoy Version

ImJoy Plugin Engine

The plugin engine used for running python plugins in ImJoy (

This library is mainly based on jupyter notebook server, with additional libraries and convenient settings.


  • If you don't have a conda environment, 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:

pip install -U imjoy[jupyter]

The above command will also install jupyter notebook and imjoy-elfinder.

  • If you encountered any error related to git or pip, try to run : conda install -y git pip before the above command. (Otherwise, please check FAQs.)


To use it after the installation:

  • Run imjoy --jupyter command in a Terminal or Anaconda Prompt, and keep the window running. You will get a link that looks like http://localhost:8888/?token=caac2d7f2e8e0...ad871fe from the terminal, please copy it for the next step.

  • Go to, click the 🚀 icon located in the upper-right corner, select Add Jupyter-Engine and paste the link you got previously, and connect to the plugin engine. Once connected, you can start to run python plugins through the plugin engine.

Please note that if you are trying to use the 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 This is because most browsers do not allow a web application served through https to connect to an unsecured server (your remote server). Alternatively, you can use a proxy to enable https for the plugin engine. Then you will be able to use it with

Connecting to a ImJoy Engine Server

import webbrowser
from imjoy_rpc import connect_to_server, launch_plugin

def new_client_join(ws):
    viewer = await ws.createWindow(src="")

async def main():
    api = await connect_to_server(server_url="")
    api.on('join', new_client_join)
    tk = await api.generate_token()
    name = api.config['name']
    token = tk['token']
    url = f"{token}&name={name}"

More details and FAQs in Docs


You can track the progress of the project here:


Please submit your bug report or feature request to ImJoy/issues


  • We use black for code formatting.
  git clone
  # Enter directory.
  cd ImJoy-Engine
  # Install all development requirements and package in development mode.
  pip3 install -r requirements_dev.txt
  • Run tox to run all tests and lint, including checking that black doesn't change any files.

Project details

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

imjoy-0.11.20.tar.gz (55.2 kB view hashes)

Uploaded Source

Built Distribution

imjoy-0.11.20-py3-none-any.whl (66.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page