rx-jupyter

RxJS 5 bindings for the Jupyter Notebook API

Usage no npm install needed!

<script type="module">
  import rxJupyter from 'https://cdn.skypack.dev/rx-jupyter';
</script>

README

rx-jupyter

This package is a ReactiveX wrapper around the Jupyter Server API. rx-jupyter can help you query local and remote Jupyter Server instances using Jupyter's Services APIs. Also, rx-jupyter integrates responses seamlessly with RxJS's functional tooling.

Roadmap

Primary coverage of the [Jupyter Server API]:

  • Contents
    • Checkpoints
  • Kernels
  • Kernelspecs
  • Sessions
  • Terminals

Optional coverage:

  • Config
  • nbconvert
  • spec.yaml /api/spec.yaml

Installation

$ yarn add rx-jupyter

$ npm install --save rx-jupyter

Usage

The example below shows how we can use this package to get the version of the Jupyter server API our endpoint is running.

import jupyter from "rx-jupyter";
import { of } from "rxjs";
import { mergeMap, catchError } from "rxjs/operators";

const apiVersion = jupyter.apiVersion({
  endpoint: "https://myjupyterendpoint.com",
  crossDomain: true
});
apiVersion.pipe(
  mergeMap(apiVersion => of(apiVersionFulfilled({ apiVersion }))),
  catchError(error => of(apiVersionFailed({ error })))
);

Documentation

You can view the reference documentation for rx-jupyter in the package docs.

Support

If you experience an issue while using this package or have a feature request, please file an issue on the issue board and add the pkg:rx-jupyter label.

License

BSD-3-Clause