Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
b18d433
Update project name and version in package files, enhance README with…
safoinme Jul 10, 2025
64def8a
Update version to 0.0.4 in package files, enhance sidebar functionali…
safoinme Jul 10, 2025
5ded93e
Add ZenML tutorial extension package (0.0.4)
safoinme Jul 10, 2025
136f3de
Update ZenML tutorial extension to version 0.0.9, enhance sidebar fun…
safoinme Jul 11, 2025
c7771a9
Update .gitignore to include .claude directory and remove settings.lo…
safoinme Jul 11, 2025
beaac71
Update ZenML tutorial extension to version 0.1.0, adjust Dockerfile a…
safoinme Jul 11, 2025
d810b6d
Merge branch 'develop' into fix/multiple-fixes-dashboard-url-window-h…
safoinme Jul 11, 2025
f204ba0
Update ZenML tutorial extension to version 0.1.0, reflecting changes …
safoinme Jul 11, 2025
2e82307
Update README to include instructions for starting the ZenML server l…
safoinme Jul 11, 2025
c0a16dd
Update ZenML tutorial extension to version 0.1.1, reflecting changes …
safoinme Jul 11, 2025
f8ab981
Update ZenML tutorial extension to version 0.1.3, including changes t…
safoinme Jul 12, 2025
9ab361f
Update ZenML tutorial extension to version 0.1.4, reflecting changes …
safoinme Jul 12, 2025
5184676
Update ZenML tutorial extension to version 0.1.5, reflecting changes …
safoinme Jul 12, 2025
c7f8c03
Update @vscode/test-cli version to 0.0.9 in package-lock.json for con…
safoinme Jul 12, 2025
782594c
Update package-lock.json to reflect dependency version upgrades, incl…
safoinme Jul 12, 2025
64eedfa
Update ZenML tutorial extension to version 0.1.6, reflecting changes …
safoinme Jul 12, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions .claude/settings.local.json

This file was deleted.

2 changes: 1 addition & 1 deletion .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
FROM python:3.11.9-slim-bookworm

# Set custom bash prompt
RUN echo "PS1='ZenML Codespace Tutorial$ '" >> /root/.bashrc
RUN echo "PS1='ZenML Tutorial$ '" >> /root/.bashrc

# Install git (dev only)
RUN apt-get -y update
Expand Down
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"workbench.startupEditor": "none"
},
"extensions": [
"zenml-io.zenml-codespace-tutorial"
"zenml-io.zenml-tutorial"
]
}
},
Expand Down
Binary file not shown.
Binary file not shown.
16 changes: 8 additions & 8 deletions .github/workflows/build-extensions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
- name: Build theme extension
run: |
echo "Building theme extension..."
cd themes && npx @vscode/vsce package --out ./zenml-color-theme-0.0.2.vsix
cd themes && npx @vscode/vsce package --out ./zenml-color-theme-0.1.1.vsix

- name: Verify extensions were builts
run: |
Expand All @@ -54,25 +54,25 @@ jobs:
exit 1
fi

if [ -f "themes/zenml-color-theme-0.0.2.vsix" ]; then
if [ -f "themes/zenml-color-theme-0.1.1.vsix" ]; then
echo "Theme extension built successfully:"
ls -la themes/zenml-color-theme-0.0.2.vsix
ls -la themes/zenml-color-theme-0.1.1.vsix
else
echo "ERROR: zenml-color-theme-0.0.2.vsix not found"
echo "ERROR: zenml-color-theme-0.1.1.vsix not found"
exit 1
fi

- name: Upload tutorial extension artifact
uses: actions/upload-artifact@v4
with:
name: tutorial-extension
path: .devcontainer/extensions/zenml-codespace-tutorial-*.vsix
path: .devcontainer/extensions/zenml-tutorial-*.vsix

- name: Upload theme extension artifact
uses: actions/upload-artifact@v4
with:
name: theme-extension
path: themes/zenml-color-theme-0.0.2.vsix
path: themes/zenml-color-theme-0.1.1.vsix

- name: Commit and push built extensions
# Only commit on push to main/develop branches, not on PRs
Expand All @@ -82,8 +82,8 @@ jobs:
git config --local user.name "GitHub Action"

# Add the built extensions to git
git add .devcontainer/extensions/zenml-codespace-tutorial-*.vsix
git add themes/zenml-color-theme-0.0.2.vsix
git add .devcontainer/extensions/zenml-tutorial-*.vsix
git add themes/zenml-color-theme-0.1.1.vsix

# Check if there are any changes to commit
if git diff --staged --quiet; then
Expand Down
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,7 @@ venv.bak/
.mypy_cache/
.dmypy.json
dmypy.json


# claude
.claude/
1 change: 1 addition & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ vsc-extension-quickstart.md
**/*.ts
**/.vscode-test.*
pipelinesBackup/
.mypy_cache/
72 changes: 69 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ This VS Code extension provides an interactive, hands-on learning experience for
</div>




## ✨ What You'll Learn

- **Pipeline Fundamentals** - Create your first ZenML pipeline
Expand Down Expand Up @@ -37,7 +35,42 @@ The fastest way to get started - no local setup required.
2. Wait ~2 min for setup (container, dependencies, extension)
3. The extension will launch automatically

### 💻 Alternative: Local Setup
### Local Setup with Extension from Marketplace

**Prerequisites:**
- Python 3.8 or higher
- VS Code

**Steps:**

1. **Set up Python virtual environment:**
```bash
python -m venv zenml-tutorial-env
source zenml-tutorial-env/bin/activate # On Windows: zenml-tutorial-env\Scripts\activate
```

2. **Install ZenML:**
```bash
pip install zenml
```

4. **Initialize ZenML:**
```bash
zenml init
```

5. **Start the ZenML server locally:**
```bash
zenml login --local
```

6. **Install the extension:**
- Install from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=zenml-io.zenml-tutorial) or search for "ZenML Tutorial" in the Extensions Marketplace

7. **Launch the tutorial:**
- Open VS Code and the extension will launch automatically

### 💻 Alternative: Local Setup with Dev Containers

**Requirements:**

Expand Down Expand Up @@ -73,6 +106,39 @@ The fastest way to get started - no local setup required.
- **Inspect** output in the terminal and Dashboard link
- **Experiment** by editing any example code

## ⚙️ Extension Configuration

### Auto-Open Tutorial

By default, the tutorial homepage opens automatically when you start VS Code. You can control this behavior:

#### 🔧 Quick Disable
When the welcome message appears, click **"Don't Show Again"** to disable auto-opening.

#### 🔧 Settings UI
1. Open VS Code Settings (`Ctrl+,` or `Cmd+,`)
2. Search for "zenml"
3. Toggle **"Auto Open Tutorial"** on/off

#### 🔧 Settings JSON
Add to your VS Code settings:
```json
{
"zenml.autoOpenTutorial": false
}
```

**Note**: You can always access the tutorial manually via the ZenML sidebar (book icon) or Command Palette (`Ctrl+Shift+P` → "ZenML: Open ZenML Tutorial Homepage").

### Dashboard URL

Configure the ZenML dashboard URL for pipeline run links:
```json
{
"zenml.dashboardUrl": "http://localhost:8237"
}
```

## 🛟 Getting Help

- **📖 ZenML Docs**: [docs.zenml.io](https://docs.zenml.io)
Expand Down
Loading
Loading