Please complete these Setup instructions, and run the Test notebooks (linked at the bottom) to confirm everything is ready for the workshop.
If you're looking at this in VS Code, please right click on the file name README.md in the File Explorer on the left and select 'Open Preview' to see it with formatting!
Each step starts with the short version. If you'd like more detail, expand the Step by step section underneath it.
Download and install Visual Studio Code from code.visualstudio.com. If you already have it, you're done with this step.
Step by step
Windows
- Go to code.visualstudio.com and click Download for Windows.
- Run the downloaded installer (
VSCodeUserSetup-...exe). - Accept the defaults and click through the installer. Leave Add to PATH checked.
- When it finishes, VS Code will launch.
Mac
- Go to code.visualstudio.com and click Download for macOS.
- Open the downloaded
.zipfile (it may unzip automatically). - Drag Visual Studio Code.app from your Downloads folder into your Applications folder.
- Open it from Applications (the first time, macOS may ask you to confirm - click Open).
Open VS Code, then open a terminal with the menu Terminal > New Terminal (or press Ctrl+` - that's the backtick key, works on both PC and Mac).
A panel appears at the bottom of the window with a blinking cursor - this is a command line running inside VS Code, and it's where you'll type the commands in the next steps. On Windows it's usually PowerShell; on Mac it's zsh. Either is fine - all the commands below work in both.
In the terminal, run:
git --version
If you see a version number (e.g. git version 2.45.0), you're set - skip to 1.4. If not, install it:
- Windows:
winget install --id Git.Git -e --source winget - Mac: run
git --versionagain and macOS will offer to install its developer tools - click Install.
Step by step
Windows
- In the VS Code terminal, type
git --versionand press Enter. - If you see an error like
git is not recognized, install git by running:(winget is Microsoft's package manager and comes built in to Windows 10 and 11.)winget install --id Git.Git -e --source winget - When it finishes, close VS Code completely and reopen it - this refreshes the terminal so it can find git.
- Open a new terminal (step 1.2) and run
git --versionagain to confirm you see a version number.
Mac
- In the VS Code terminal, type
git --versionand press Enter. - If git isn't installed, macOS pops up a dialog offering to install the Command Line Developer Tools. Click Install, accept the license, and wait for it to finish (a few minutes).
- Run
git --versionagain to confirm you see a version number.
In the terminal, run:
git clone https://github.com/ed-donner/workshop
Step by step
- "Cloning" downloads a copy of this project to your computer.
- The terminal starts in your home folder by default, which is a fine place for it. If you prefer to keep projects somewhere specific (like a
projectsfolder), move there first withcd, e.g.cd projects. - Run:
git clone https://github.com/ed-donner/workshop - This creates a folder called
workshopcontaining the project. Note where it is - you'll open it in the next step. To see the full location, runcd workshopand thenpwd.
Open the workshop folder you just cloned: File > Open Folder..., select the workshop folder, and click Open (on Mac the button says Open; the menu item may say Open...).
You'll know it worked when the Explorer sidebar on the left shows WORKSHOP in capital letters at the top.
Step by step
- In VS Code, click File in the menu bar, then Open Folder... (on Mac this may appear as Open...).
- Navigate to where you cloned the project in step 1.4 - your home folder unless you chose somewhere else. Home is
C:\Users\<your name>on Windows, or/Users/<your name>on Mac (in the Mac dialog, press Cmd+Shift+H to jump straight to your home folder). - Click the
workshopfolder once to select it (don't double-click into a folder inside it), then click Select Folder (Windows) or Open (Mac). - If VS Code asks "Do you trust the authors of the files in this folder?", click Yes, I trust the authors.
- Check the Explorer sidebar on the left (the top icon that looks like two stacked files - or press Ctrl+Shift+E / Cmd+Shift+E). The very top of the panel should read WORKSHOP in capital letters.
- If you see a different name in capitals (like your username or PROJECTS), you opened the wrong folder - go back to File > Open Folder... and make sure you select the
workshopfolder itself.
Open the Extensions view (Ctrl+Shift+X / Cmd+Shift+X) and install Python and Jupyter, both by Microsoft. If they're already installed, you're done.
Step by step
- In VS Code, click the Extensions icon in the left sidebar (four squares, with one detached) - or press Ctrl+Shift+X on Windows, Cmd+Shift+X on Mac.
- In the search box at the top, type Python.
- Find Python with Microsoft as the publisher (usually the first result) and click Install. If you see a gear icon instead of an Install button, it's already installed.
- Now search for Jupyter, find the one published by Microsoft, and click Install.
- Each may pull in a few companion extensions automatically (like Pylance) - that's expected.
We use uv, a fast Python package manager. It handles everything - including installing Python itself - so this is the only tool you need.
For all of Part 2, work in a VS Code terminal (Terminal > New Terminal) with the workshop project open, so the terminal starts in the right folder.
In the terminal, run:
uv --version
If you see a version number, skip to 2.2. If not, install uv with the default (standalone) installer from the uv installation page:
- Windows:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" - Mac:
curl -LsSf https://astral.sh/uv/install.sh | sh
Then close and reopen VS Code, open a new terminal, and confirm uv --version works.
uv self update
This makes sure you're on the latest version. If you just installed uv, it will say it's already up to date - that's fine. If you get an error saying self-update is not available, your uv came from a package manager like Homebrew or winget - update it the same way you installed it (e.g. brew upgrade uv).
uv sync
Step by step
- Make sure the terminal is in the
workshopfolder. If you opened the workshop project in VS Code (step 1.5), any new terminal starts there automatically - the prompt shows the folder name. - Run
uv sync. - uv reads the project configuration, downloads the right version of Python if needed, creates a private environment for this project, and installs all the packages. The first run can take a minute or two.
- When it finishes without errors, you're done. If it complains it can't find
pyproject.toml, the terminal is in the wrong folder - runcd workshop(or reopen the project as in step 1.5) and try again.
Look at the Explorer sidebar: a new folder called .venv should have appeared at the top level of the project, right under WORKSHOP.
Step by step
- Open the Explorer sidebar (Ctrl+Shift+E / Cmd+Shift+E).
- Under WORKSHOP, you should see a folder named
.venv(it may look slightly dimmed - that's normal). - This folder contains the project's own private copy of Python and all its packages, created by
uv sync. - Don't see it? Run
lsin the terminal to double-check, and make sure step 2.3 completed without errors in theworkshopfolder.
The project reads your API key from a file called .env. This file stays on your machine and holds your secret key.
In the Explorer sidebar, right-click in the empty area below the files, choose New File..., and name it exactly:
.env
Step by step
- Open the Explorer sidebar (Ctrl+Shift+E / Cmd+Shift+E).
- Right-click in the empty space below the list of files - not on a folder - so the new file lands at the top level of the project.
- Choose New File... from the menu.
- Type
.envand press Enter. The name starts with a dot and has nothing after "env" - not.env.txt, notenv. - The file opens in the editor, empty. Check the Explorer:
.envshould sit at the top level, directly under WORKSHOP alongside the other files - not inside a folder. If it landed in the wrong place, drag it to the top level.
Type one line into the file, depending on which workshop you're attending:
- Claude workshop:
ANTHROPIC_API_KEY=sk-ant-... - ADK workshop:
GOOGLE_API_KEY=AIz...
Replace the sk-ant-... or AIz... part with your actual key.
Step by step
- Click into the empty
.envfile in the editor. - Type the variable name for your workshop (
ANTHROPIC_API_KEYorGOOGLE_API_KEY), then=, then paste your full key. - Everything goes on one line: no spaces around the
=, no quotes around the key. - Anthropic keys start with
sk-ant-; Google keys start withAIz. If yours doesn't, double-check you copied the whole key.
Press Ctrl+S (Windows) or Cmd+S (Mac). The dot on the file's tab turns into an x when it's saved.
If you're part of the group that will be using Google ADK (and your team uses ADK today):
- Please double click on
adk.ipynbin the File Explorer on the left and follow the instructions
If you're part of the group that will be using Claude:
- Please double click on
claude.ipynbin the File Explorer on the left and follow the instructions