A copier template for creating the Visual Studio Code configuration needed to debug the Python and Typescript code in Jupyter extension projects.
It will add:
- Debug configuration to debug your code in Visual Studio Code
- [recommended] Development container (can be used to develop within a container) - see installation documentation
The best is to run this on project generated by the extension template.
- Install copier.
pip install copier
or
conda install copier
- Navigate to the root of your Jupyter project, then run
For copier v8
copier copy -a .copier-answer.vscode.yml --UNSAFE https://github.com/jupyterlab/vscode-config-template .
The
--UNSAFE
flag is required as explained in the documentation.
For copier v7
copier -a .copier-answer.vscode.yml copy https://github.com/jupyterlab/vscode-config-template .
-
Answer the options questions
-
Install the extension
pip install -e ".[test]"
jupyter labextension develop . --overwrite
# Server extension must be manually enabled in develop mode
# jupyter server extension enable <python_name>
- Optional, start watching your extension source changes
jlpm run watch
- Inside Visual Studio Code Debug panel, use Debug JupyterLab with Chrome.
To update the configuration to a newer version of the template, execute:
For copier v8
copier update -a .copier-answer.vscode.yml --UNSAFE
The
--UNSAFE
flag is required as explained in the documentation.
For copier v7
copier -a .copier-answer.vscode.yml update