Environment Setup

Prerequisites

Throughout this workshop, we’ll be using an example project to help María in her task.

After each part, we can refer to the corresponding completed version of the code, under the branch part_#.

This is quite important if you fall behind, as you can start from the last complete milestone.

Now, let’s get started!

Visit the tutorial repo and fork the repository by clicking “Fork” > “Create a new fork” You will be redirected to a fork of this repository in your account or organization.
Make sure to uncheck the box Copy the 'main' branch only, to include all the branches.
Once our repo is created, click on the Code menu, and from the Codespaces tab, click Create codespace on main. This will open the code in GitHub Codespaces where we will be incrementally making updates to the code.

This repository contains all the information required for the workshop.

We’ll be installing our Python dependencies in a Python virtual environment (venv).

Even while on Codespaces, it is good practice to create a venv for our project’s dependencies.

To create and activate a Python3.12 venv:

python3.12 -m venv /workspaces/orchestration-workshop-tutorial/.venv
source /workspaces/orchestration-workshop-tutorial/.venv/bin/activate

NOTE: You can exit out of the venv by typing:
deactivate

Once we’ve activated our venv, we can now install PyPI dependencies. We’ll be installing a few throughout this tutorial.

pip install -r requirements.txt

⚠️ This venv contains all your base dependencies, ensure you have not deactivated it accidentally when switching branches.

If we prefer to work outside Codespaces, you can clone your fork first:

git clone <our-fork-url>

The examples reference paths relative to the Codespaces base location; ensure you modify them as appropriate for your environment.