https://github.com/jupyterlab/jupyterlab_server

A set of server components for JupyterLab and JupyterLab like applications
https://github.com/jupyterlab/jupyterlab_server

jupyterlab

Last synced: 11 days ago
JSON representation

A set of server components for JupyterLab and JupyterLab like applications

• Host: GitHub
• URL: https://github.com/jupyterlab/jupyterlab_server
• Owner: jupyterlab
• License: bsd-3-clause
• Created: 2017-04-20T19:41:59.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2025-02-24T10:49:49.000Z (about 2 months ago)
• Last Synced: 2025-04-11T08:57:36.491Z (11 days ago)
• Topics: jupyterlab
• Language: Python
• Homepage: http://jupyterlab-server.readthedocs.io/en/stable/
• Size: 832 KB
• Stars: 143
• Watchers: 16
• Forks: 101
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jupyterlab server

[![Build Status](https://github.com/jupyterlab/jupyterlab_server/workflows/Tests/badge.svg?branch=master)](https://github.com/jupyterlab/jupyterlab_server/actions?query=branch%3Amaster+workflow%3A%22Tests%22)

[![Documentation Status](https://readthedocs.org/projects/jupyterlab-server/badge/?version=stable)](http://jupyterlab-server.readthedocs.io/en/stable/)

## Motivation

JupyterLab Server sits between JupyterLab and Jupyter Server, and provides a

set of REST API handlers and utilities that are used by JupyterLab. It is a separate project in order to

accommodate creating JupyterLab-like applications from a more limited scope.

## Install

`pip install jupyterlab_server`

To include optional `openapi` dependencies, use:

`pip install jupyterlab_server[openapi]`

To include optional `pytest_plugin` dependencies, use:

`pip install jupyterlab_server[test]`

## Usage

See the full documentation for [API docs](https://jupyterlab-server.readthedocs.io/en/stable/api/index.html) and [REST endpoint descriptions](https://jupyterlab-server.readthedocs.io/en/stable/api/rest.html).

## Extending the Application

Subclass the `LabServerApp` and provide additional traits and handlers as appropriate for your application.

## Contribution

Please see `CONTRIBUTING.md` for details.