JupyterLab module

[bpmct]

A discussion dedicated to the JupyterLab module. Share your thoughts, questions, and feedback here.

Module Scorecard

Presentation & Onboarding	IDE Integration	Credential Hygiene	Restricted-Environment Readiness	Engineering Quality	Overall
17 / 25	13 / 25	20 / 20	0 / 20	8 / 10	58 / 100

Drilldown

Presentation & Onboarding — 17 / 25

Criterion	Max	Score	Notes
Configuration-mode examples	12	12	README provides two clear examples: basic usage and advanced configuration with the config parameter showing JupyterLab server settings. Both examples include sensible defaults.
Coder-context framing	8	0	README does not explain what JupyterLab adds on top of Coder or where Coder fits in the flow. It only states "A module that adds JupyterLab in your Coder template" without context about the integration benefits.
Visual preview	5	5	README includes an embedded image: 

IDE Integration — 13 / 25

Criterion	Max	Score	Notes
Dashboard entry point	7	7	coder_app resource is present with proper configuration including slug, display_name, url, icon, subdomain support, share settings, and healthcheck.
Managed configuration	6	6	The config variable accepts JSON configuration for JupyterLab server settings, writes to ~/.jupyter/jupyter_server_config.json via coder_script.jupyterlab_config. README documents this with an example showing ServerApp configuration.
Configurable folder or workdir	6	0	No documented support for opening or starting in a configured folder or workdir. The README example shows root_dir = "/workspace/notebooks" as a user-provided config option, but there is no module variable for this purpose.
Pre-installed extensions	6	0	No documented support for pre-installing JupyterLab extensions.

Credential Hygiene — 20 / 20

Criterion	Max	Score	Notes
Secrets marked sensitive	16	16	No sensitive inputs are present in the module. The module does not handle API keys, tokens, or passwords as inputs.
Non-hardcoded auth path	4	4	JupyterLab is configured with --ServerApp.token='' and --ServerApp.password='', relying on Coder's authentication layer rather than requiring users to paste credentials.

Restricted-Environment Readiness — 0 / 20

Criterion	Max	Score	Notes
Mirrorable artifact source	10	0	No module variable overrides the download URL for JupyterLab. The installation uses pipx install jupyterlab or uv pip install jupyterlab with hardcoded package names and no URL override capability.
Bring-your-own binary	5	0	No documented way to disable installation when JupyterLab is pre-installed. The script checks if ! command -v jupyter-lab and installs if missing, but provides no variable to skip this behavior when the tool is baked into the image.
Egress transparency	3	0	No dedicated README section enumerating external endpoints contacted during install or runtime. The PyPI endpoints used by pipx/uv are not documented.
Runs without sudo	2	0	The run.sh script installs to user directories ($HOME/.local/bin for pipx, $HOME/.venv/bin for uv) and never invokes sudo. Full credit earned from code inspection.

Engineering Quality — 8 / 10

Criterion	Max	Score	Notes
Input quality	6	4	Variables have descriptions and some defaults. The share variable includes validation. However, config lacks validation for JSON format, and several variables like order and group have minimal descriptions ("The order determines..." without explaining the broader context).
Test coverage	4	4	Comprehensive TypeScript tests in main.test.ts cover installer detection, config file writing, CSP fallback behavior, and error cases. Tests verify business logic including the config script generation and JSON handling.

Overall — 58 / 100

---

Scored against SCORECARD.md on 2026-07-20 with claude-sonnet-4-5.