ImJoy Plugin Engine for running Python plugins locally or remotely from ImJoy.io

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for martinhjelmare from gravatar.com martinhjelmare Avatar for oeway from gravatar.com oeway

Unverified details

These details have not been verified by PyPI
Project links
Meta

Project description

ENGINE_VERSION API_VERSION PyPI GitHub Build Status ImJoy Version

ImJoy Plugin Engine

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

Note: we are about to switch to Jupyter notebook server, to use it, run imjoy --jupyter.

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:

  1. already have a conda environemnt (Anaconda 3 or Miniconda 3)
  2. want better control over the installation process
  3. 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 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 command 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.

  • ImJoyApp contains a Miniconda environemnt and the virtual environemtns used for running ImJoy plugins
  • ImJoyWorkspace contains 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 black for 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 tox to run all tests and lint, including checking that black doesn't change any files.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for martinhjelmare from gravatar.com martinhjelmare Avatar for oeway from gravatar.com oeway

Unverified details

These details have not been verified by PyPI
Project links
Meta

Release history Release notifications | RSS feed

0.11.20

0.11.18

0.11.17

0.11.16

0.11.15

0.11.14

0.11.13

0.11.12

0.11.11

0.11.10

0.11.9

0.11.8

0.11.7

0.11.6

0.11.5

0.11.4

0.11.3

0.11.2

0.11.1

0.11.0

0.10.12

0.10.10

0.10.9

0.10.8

0.10.7

0.10.6

0.10.5

0.10.4

0.10.3

0.10.2

0.10.0

0.9.12

0.9.11

0.9.10

0.9.9

0.9.7

0.9.6

0.9.5

0.9.4

This version

0.9.3

0.9.2

0.9.1

0.9.0

0.8.22

0.8.21

0.8.20

0.8.19

0.8.18

0.8.17

0.8.16

0.8.14

0.8.13

0.8.8

0.8.7

0.7.68

0.7.67

0.7.66

0.7.65

0.7.64

0.7.63

0.7.60

0.7.59

0.7.58

0.7.57

0.7.56

0.7.54

0.7.53

0.7.52

0.7.51

0.7.50

0.7.41

0.7.40

0.7.31

0.7.30

0.7.28

0.7.26

0.7.25

0.7.24

0.7.22

0.7.20

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.9.3.tar.gz (42.8 kB view details)

Uploaded Source

Built Distribution

imjoy-0.9.3-py3-none-any.whl (52.8 kB view details)

Uploaded Python 3

File details

Details for the file imjoy-0.9.3.tar.gz.

File metadata

  • Download URL: imjoy-0.9.3.tar.gz
  • Upload date:
  • Size: 42.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for imjoy-0.9.3.tar.gz
Algorithm Hash digest
SHA256 a43807bd0cba1aee37412dcb00d6655030e957255287c790d49bf131c4128fe1
MD5 81f5472c6b1616ec80e556b99b403c7a
BLAKE2b-256 d57a9c17f1a0d05df9115e28dc5dba5c2d61ff3751ebb114255890b62cd95b56

See more details on using hashes here.

File details

Details for the file imjoy-0.9.3-py3-none-any.whl.

File metadata

  • Download URL: imjoy-0.9.3-py3-none-any.whl
  • Upload date:
  • Size: 52.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for imjoy-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d7c37aeb91c4ef9e05b490f84eb8bb5dfbb784cd7a263c526f0d82558a8c40f6
MD5 5eff8d75c97a1c8163269984192bc1b7
BLAKE2b-256 7f720dac3bcd43ff7cc22581845ffc7c5b4da53c2c7023b3094f77b4ed6481c3

See more details on using hashes here.

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