暫無描述

Jeremy Tuloup c81b7891d0 Move main.yml to wheel.yml 5 年之前
.github c81b7891d0 Move main.yml to wheel.yml 5 年之前
binder ea94acf90e v0.2.0 5 年之前
examples 87d4d3b8d1 Initial support for handling msgs for other cells 5 年之前
schema 485a174abf Map kernel names to variable filters 5 年之前
src 92d8690d1a Merge pull request #397 from jtpio/variables-panel 5 年之前
style 92d8690d1a Merge pull request #397 from jtpio/variables-panel 5 年之前
tests ae9a018862 Create session connection instead of context in tests 5 年之前
.gitignore 5f8c84b0ec Added .orig files to gitignore 5 年之前
.prettierignore 1910f45233 Add .prettierignore file 5 年之前
.prettierrc 65b4154a8c Add .prettierrc 5 年之前
DESIGN.md f8f82ebdfe Fix design file location. 5 年之前
LICENSE 64db2dfe4b Update LICENSE 5 年之前
README.md 8a771380ee Update the instructions to install the extension 5 年之前
package.json ea94acf90e v0.2.0 5 年之前
screencast.gif d7015ddb03 Add screencast 5 年之前
tdoptions.json 9e67f61b69 Add a shell JupyterLab extension. 5 年之前
tsconfig.json 25bfc84fb0 Add scaffolding for tests 5 年之前
tslint.json 2b431c1d42 Add tslint config for sorted imports 5 年之前

README.md

@jupyterlab/debugger

Github Actions Status Binder npm

A JupyterLab debugger UI extension. This extension is under active development.

screencast

Prerequisites

  • JupyterLab 2.0+
  • xeus-python 0.6.7+
  • notebook 6+

Installation

A kernel with support for debugging is required to be able to use the debugger.

It is generally recommended to create a new conda environment to install the dependencies:

conda create -n jupyterlab-debugger -c conda-forge xeus-python=0.6.12 notebook=6 jupyterlab=2 ptvsd
conda activate jupyterlab-debugger

Then, run the following command to install the extension:

jupyter labextension install @jupyterlab/debugger

Development

# Create a new conda environment
conda create -n jupyterlab-debugger -c conda-forge nodejs xeus-python=0.6.12 ptvsd jupyterlab=2

# Activate the conda environment
conda activate jupyterlab-debugger

# Install dependencies
jlpm

# Build TypeScript source
jlpm build

# Link your development version of the extension with JupyterLab
jupyter labextension link .

# Rebuild TypeScript source after making changes
jlpm build

# Rebuild JupyterLab after making any changes
jupyter lab build

# Start JupyterLab with the kernel logs enabled and watch mode enabled
XEUS_LOG=1 jupyter lab --no-browser --watch

Tests

To run the tests:

# [Optional] to enable the logs for xeus-python
export XEUS_LOG=1

jlpm run test

To run tests for a specific test suite name:

jlpm run test --testNamePattern=<regex>

To run tests for a specific test module name:

jlpm run test --testPathPattern=<regex>

Inspecting debug messages

The kernelspy extension for JupyterLab can be used to inspect the debug messages sent between the debugger UI and the kernel.

To install it:

jupyter labextension install jupyterlab-kernelspy