Skip to main content

Jupyter server proxy wrapper for Open Refine

Project description

nb_serverproxy_openrefine

Jupyter server proxy for OpenRefine

Based on the original https://github.com/psychemedia/jupyterserverproxy-openrefine which has some docs, although the reponame/install instructions will need updating for this repo. I will pop the package on PyPi at some point.

Jupyter-server-proxy config for running OpenRefine.

Install as:

pip install nb-serverproxy-openrefine

To install directly from this repo:

pip install git+https://github.com/innovationOUtside/nb_serverproxy_openrefine.git

Open to Notebook homepage: Binder

Open to OpenRefine: Binder

Open to Jupyterlab: Binder

OpenRefine can now be started and launched from the notebook homepage New menu:

Or from the JupyterLab launcher:

The OpenRefine client can be found on the openrefine path (the port number is allocated dynamically).

Calling the path directly (eg starting MyBinder with the path openrefine, or adding ?urlpath=openrefine to the Binder URL) will launch the Binder container directly into the OpenRefine GUI application.

The directory path into which the OpenRefine project files are saved is $HOME/openrefine by default, although you can trump it via the $REFINE_DIR global variable:

openrefine_path =  os.getenv("REFINE_DIR") if "REFINE_DIR" in os.environ else str(Path.home() / 'openrefine')

Early original work on getting OpenRefine running in MyBinder was done by @betatim (betatim/openrefineder) and @yuvipanda helped me get my head round various bits of jupyterhub/jupyter-server-proxy/ which is key to proxying web services via Jupyter. @manics PR for handling predefined, rather than allocated, port mappings also made life much easier...

Python Client

A Python client is also available for working with OpenRefine:

Using the client requires Open Refine to be running. TO DO: should we hardwire the port? Else how do we know where to connect?:

When the client works with Python3 I will add it as an optional dependency to this package.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nb-serverproxy-openrefine-0.0.4.tar.gz (8.0 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page