JupyterLab Services

Javascript client for the Jupyter services REST APIs

API Docs

REST API Docs

Note: All functions and classes using the REST API allow a serverSettings
parameter to configure requests.

Requests are made using the fetch API, which is available in modern browsers or in Node 18+.

Package Install

Prerequisites

- node
- Python, e.g. via conda

``bash
npm install --save @jupyterlab/services
conda install jupyter-server # jupyter-server 2.0+ is recommended


or pip install jupyter-server


`

Source Build

Prerequisites

See the building instructions for JupyterLab, which
will build this module as part of the build process.

Rebuild

`bash
yarn run clean
yarn run build
`

Run Tests

Follow the source build instructions first.

`bash
yarn run test
`

Build Docs

Follow the source build instructions first.

`bash
yarn run docs
`

Navigate to docs/index.html.

Supported Runtimes

The runtime versions which should work are listed below. Earlier versions may
also work, but come with no guarantees.

- Node 10
- Firefox 52+
- Chrome 55+

Note: "requirejs" may need be included in a global context for Comm targets
using the a target_module (in the classic Notebook).
This can be as a