Skip to content
This repository has been archived by the owner on Aug 16, 2022. It is now read-only.

Latest commit

 

History

History
57 lines (35 loc) · 3.56 KB

README.md

File metadata and controls

57 lines (35 loc) · 3.56 KB
Raw

ENGINE_VERSION PyPI GitHub Build Status ImJoy Version

ImJoy Plugin Engine

The plugin engine used for running python plugins in ImJoy (https://imjoy.io).

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

Installation

  • 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.)

Usage

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 https://imjoy.io, 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 https://imjoy.io. 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 https://imjoy.io.

Connect to ImJoy Engine Server

We are deprecating the ImJoy Engine, the recommended way to setup a python server is to use the new python library Hypha.

Here you can find more information on how to set up hypha.

More details and FAQs in Docs

Roadmap

You can track the progress of the project here: https://github.com/imjoy-team/ImJoy/projects/2

Issues

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

Development

  • We use black for code formatting.
  git clone [email protected]: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
  • Run tox to run all tests and lint, including checking that black doesn't change any files.