Skip to content

Commit 5503f00

Browse files
authored
Merge pull request #15 from acceleratescience/12-add-devcontainer
Add devcontainer
2 parents 96602e6 + f2839cd commit 5503f00

3 files changed

Lines changed: 88 additions & 1 deletion

File tree

.devcontainer/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Dev Container Configuration
2+
3+
This directory contains the development container configuration for the Hands-on LLMs workshop.
4+
5+
## What gets installed
6+
7+
When a user opens this repository in GitHub Codespaces, the following will be automatically set up:
8+
9+
### Base Environment
10+
- Python 3.11 (Debian Bullseye)
11+
- Git and GitHub CLI
12+
13+
### VS Code Extensions
14+
- Python development: Python, Pylance, Black formatter, Ruff linter
15+
- Jupyter notebooks: Full Jupyter support with renderers and keybindings
16+
- General development: JSON, YAML, and Markdown support
17+
18+
### Port Forwarding
19+
- **Port 8501**: Streamlit applications
20+
- **Port 8888**: Jupyter notebook server
21+
22+
## Usage
23+
24+
Users simply need to:
25+
1. Fork this repository
26+
2. Open in GitHub Codespaces
27+
3. Wait for the automatic setup to complete
28+
4. Start working with the workshop materials
29+
30+
The environment will be ready to use with all dependencies installed and VS Code properly configured for Python and Jupyter development.

.devcontainer/devcontainer.json

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
{
2+
"name": "Packaging and Publishing Workshop",
3+
"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
4+
5+
"features": {
6+
"ghcr.io/devcontainers/features/git:1": {},
7+
"ghcr.io/devcontainers/features/github-cli:1": {}
8+
},
9+
10+
"customizations": {
11+
"vscode": {
12+
"extensions": [
13+
"ms-python.python",
14+
"ms-python.vscode-pylance",
15+
"ms-toolsai.jupyter",
16+
"ms-toolsai.jupyter-keymap",
17+
"ms-toolsai.jupyter-renderers",
18+
"ms-python.black-formatter",
19+
"charliermarsh.ruff",
20+
"ms-vscode.vscode-json",
21+
"redhat.vscode-yaml",
22+
"ms-vscode.vscode-markdown"
23+
],
24+
"settings": {
25+
"python.defaultInterpreterPath": "/usr/local/bin/python",
26+
"python.linting.enabled": true,
27+
"python.linting.pylintEnabled": false,
28+
"python.linting.flake8Enabled": false,
29+
"python.formatting.provider": "black",
30+
"jupyter.askForKernelRestart": false,
31+
"files.associations": {
32+
"*.ipynb": "jupyter-notebook"
33+
}
34+
}
35+
}
36+
},
37+
38+
"remoteUser": "vscode",
39+
40+
"forwardPorts": [8501, 8888],
41+
42+
"portsAttributes": {
43+
"8501": {
44+
"label": "Streamlit",
45+
"onAutoForward": "notify"
46+
47+
},
48+
"8888": {
49+
"label": "Jupyter",
50+
"onAutoForward": "notify"
51+
}
52+
}
53+
}

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,4 +146,8 @@ Testing/
146146
#poetry.lock
147147

148148
# Pylance
149-
.ipynb_checkpoints/
149+
.ipynb_checkpoints/
150+
151+
# PyCharm project files
152+
# These files are machine specific and not useful to developers on VS Code or other editors
153+
.idea/

0 commit comments

Comments
 (0)