Skip to content

Commit 0e99604

Browse files
authored
Add VS Code hint for Codespaces and preinstall Python/Jupyter extensions (#262)
* docs: add VS Code tip for Codespaces and preinstall Python/Jupyter extensions Lead the Codespaces section with the simplest path — run notebooks directly in the default VS Code editor, skipping the Jupyter token and port-8888 steps. Preinstall the ms-python.python and ms-toolsai.jupyter extensions via the devcontainer so they are ready on first launch. * docs: add VS Code tip to the published Codespaces install page The workshop website (built by zensical from web/docs/index.md) has its own GitHub Codespaces section; mirror the README tip there so users reading the published install page also see the simpler VS Code path.
1 parent 6d64410 commit 0e99604

3 files changed

Lines changed: 16 additions & 0 deletions

File tree

.devcontainer/devcontainer.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,13 @@
77
"features": {
88
"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {}
99
},
10+
"customizations": {
11+
"vscode": {
12+
"extensions": [
13+
"ms-python.python",
14+
"ms-toolsai.jupyter"
15+
]
16+
}
17+
},
1018
"postStartCommand": "docker compose -f /workspaces/${localWorkspaceFolderBasename}/workshop/docker-compose-services.yml up -d && jupyter notebook --ip 0.0.0.0 --no-browser --port 8888 --allow-root"
1119
}

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,12 @@ jupyter notebook
109109

110110
### Running from Github Codespaces
111111

112+
> **Tip:** the simplest way to run the exercises is to open the Codespace in
113+
> VS Code (the default when you launch a Codespace) and run the notebooks from
114+
> the editor — select the Python kernel when prompted and run the cells. VS Code
115+
> talks to the kernel directly, so you can skip the Jupyter token and port-8888
116+
> steps described below.
117+
112118
You can also use Github Codespaces after forking the repository:
113119
<img width="719" height="248" alt="image" src="https://github.com/user-attachments/assets/aa467a75-9ab9-46a2-98d3-ca8c4c278481" />
114120

web/docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@ If you somehow were not able to install Docker, or had trouble starting the work
214214

215215
### GitHub Codespaces
216216

217+
**Tip:** the simplest way is to open the Codespace in VS Code (the default when you launch a Codespace) and run the notebooks directly from the editor — select the Python kernel when prompted and run the cells. VS Code talks to the kernel directly, so you can skip the Jupyter token steps below.
218+
217219
To run this workshop via GitHub Codespaces, please complete the following steps:
218220

219221
- Navigate to https://github.com/geopython/geopython-workshop

0 commit comments

Comments
 (0)