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
19 / 25	13 / 25	20 / 20	0 / 20	8 / 10	60 / 100

Drilldown

Presentation & Onboarding — 19 / 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 including CSP headers and root_dir
Coder-context framing	8	2	README states "adds JupyterLab in your Coder template" but does not explain what JupyterLab is, what Coder adds on top of it, or show where Coder fits in the workflow. Minimal context provided
Visual preview	5	5	README includes  showing the module in action

IDE Integration — 13 / 25

Criterion	Max	Score	Notes
Dashboard entry point	7	7	coder_app resource present with proper healthcheck, subdomain support, and URL configuration for both subdomain and path-based access
Managed configuration	6	6	config variable documented with JSON configuration support, writes to ~/.jupyter/jupyter_server_config.json, includes CSP fallback and example showing ServerApp settings
Configurable folder or workdir	6	0	No documented support for opening or starting in a configured folder. The example shows root_dir = "/workspace/notebooks" as part of general config but this is not documented as a dedicated workdir feature
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 in the module. The example config shows token: "test-token" in test code but README examples use empty token/password which is appropriate for Coder's authenticated environment
Non-hardcoded auth path	4	4	Module runs JupyterLab with --ServerApp.token='' and --ServerApp.password='', relying on Coder's authentication layer. No raw keys required

Restricted-Environment Readiness — 0 / 20

Criterion	Max	Score	Notes
Mirrorable artifact source	10	0	No module variable to override the JupyterLab download/install URL. The script uses hardcoded pipx install jupyterlab or uv pip install jupyterlab with no URL override capability
Bring-your-own binary	5	0	No documented way to skip installation when JupyterLab is pre-installed. Script checks command -v jupyter-lab and skips install if found, but this is not documented in README
Egress transparency	3	0	No dedicated README section enumerating external endpoints. PyPI access for pip/pipx/uv installation is implicit but not documented
Runs without sudo	2	0	Script installs to user directories ($HOME/.local/bin, $HOME/.venv/bin) and never invokes sudo. However, the script exits with error if neither pipx nor uv is available, requiring these tools to be pre-installed with potential sudo during image build. Core functionality requires external package installation capability

Engineering Quality — 8 / 10

Criterion	Max	Score	Notes
Input quality	6	4	Variables have descriptions and some defaults. share has validation. However, config variable lacks validation for JSON format, and several variables like order and group have minimal descriptions
Test coverage	4	4	Comprehensive TypeScript tests in main.test.ts covering installer detection, config file writing, CSP fallback behavior, and error cases. Tests verify end-to-end behavior including container execution

Overall — 60 / 100

---

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