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.
Primary coverage of the [Jupyter Server API]:
- Contents
- Checkpoints
- Kernels
- Kernelspecs
- Sessions
- Terminals
Optional coverage:
- Config
- nbconvert
- spec.yaml
/api/spec.yaml
$ yarn add rx-jupyter
$ npm install --save rx-jupyter
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 })))
);
You can view the reference documentation for rx-jupyter
in the package docs.
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.