/jupyter-odannotation-proxy

Primary LanguagePython

jupyter-odannotation-proxy

This package was built using the jupyter-server-proxy cookiecutter template.

Binder

Requirements

(Optional) For testing:

This package executes the standard odannotation command. This command assumes the odannotation command is available in the environment's PATH. For convenience, the tests include cases that assert outputs when running the odannotation command from a docker container. If you don't need to run tests with this setup running in a docker container, then remove the tests/test_odannotation_docker.py file or comment out the code in the file.

Quick Starts

Launch with binder

This test requires you to have a database instance available as a public endpoint or installed within the notebook container itself.

Binder

The Hard Way

Create and Activate Environment

virtualenv -p python3 venv
source venv/bin/activate

Install jupyter-odannotation-proxy

pip install git+https://github.com/jisd2089/jupyter-odannotation-proxy.git

Enable jupyter-odannotation-proxy Extensions

  1. For Jupyter Classic, activate the jupyter-server-proxy extension:
jupyter serverextension enable --sys-prefix jupyter_server_proxy
  1. For Jupyter Lab, install the @jupyterlab/server-proxy extension:
jupyter labextension install @jupyterlab/server-proxy
jupyter lab build

  1. Start Jupyter Classic or Jupyter Lab

  2. Click on the odannotation icon from the Jupyter Lab Launcher or the odannotation item from the New dropdown in Jupyter Classic.

Credits

License

BSD 3-Clause