From cc523cf7cb6dda5242a30bc6a4240c1a542b6fae Mon Sep 17 00:00:00 2001 From: Alex Garnett Date: Thu, 30 Jan 2025 13:38:50 -0800 Subject: [PATCH 1/2] port to codespaces --- .devcontainer/devcontainer.json | 15 +++++ README.md | 29 ++++----- codespaces.md | 59 +++++++++++++++++++ exercises/debug-activity/README.md | 4 -- exercises/durable-execution/README.md | 4 -- exercises/testing-code/README.md | 4 -- .../README.md | 4 -- 7 files changed, 87 insertions(+), 32 deletions(-) create mode 100644 .devcontainer/devcontainer.json create mode 100644 codespaces.md diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..ffd15ca --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,15 @@ +{ + "image": "temporalio/gitpod-edu:1.4", + "customizations": { + "codespaces": { + "openFiles": [ + "README.md" + ] + } + }, + "forwardPorts": [8080, 7233, 9999], + "postCreateCommand": "python3 -m venv .env && bash -c 'source .env/bin/activate && python3 -m pip install -r requirements.txt' && echo 'source /workspaces/edu-102-python-code/.env/bin/activate' >> ~/.bashrc && temporal server start-dev --ui-port 8080", + "remoteEnv": { + "PROMPT_DIRTRIM": "2" + } +} diff --git a/README.md b/README.md index 15dc47a..9af6ccc 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ training course. It's important to remember that the example code used in this course was designed to support learning a specific aspect of Temporal, not to serve as a ready-to-use template for implementing a production system. -For the exercises, make sure to run `temporal server start-dev --ui-port 8080 --db-filename clusterdata.db` in one terminal to start the Temporal server. For more details on this command, please refer to the `Setting up a Local Development Environment` chapter in the course. Note: If you're using the Gitpod environment to run this exercise, you can skip this step. +For the exercises, make sure to run `temporal server start-dev --ui-port 8080 --db-filename clusterdata.db` in one terminal to start the Temporal server. For more details on this command, please refer to the `Setting up a Local Development Environment` chapter in the course. Note: If you're using the Codespaces environment to run this exercise, you can skip this step. ## Hands-On Exercises @@ -32,12 +32,21 @@ The following links provide additional information that you may find helpful as - [Temporal Python SDK Documentation](https://python.temporal.io/) - [Python Language Documentation](https://docs.python.org/3/) - [Python Packaging and Virtual Environment Documentation](https://packaging.python.org/en/latest/tutorials/installing-packages/#creating-virtual-environments) -- [GitPod Documentation: Troubleshooting](https://www.gitpod.io/docs/troubleshooting) + +## Exercise Environment for this Course + +You can launch an exercise environment for this course using GitHub Codespaces by +following [this](codespaces.md) walkthrough. + +Alternatively, you can follow +[these instructions](https://learn.temporal.io/getting_started/python/dev_environment/) to +set up your own Temporal Cluster with Docker Compose, which you can use as an +exercise environment. ### Setup Your Python Virtual Environment All Python libraries for this course should be installed in a virtual environment. -If you are running these exercises in the course's GitPod environment, there +If you are running these exercises in the course's Codespaces environment, there is a virtual environment already setup for you and you can skip this section. (Be certain that you are running Python 3.7+. If you system has) @@ -91,16 +100,4 @@ $ source env/bin/activate $ env\Scripts\activate ``` -However, the packages are already installed, so there is no need to run pip again. - -## Exercise Environment for this Course - -You can launch an exercise environment for this course in GitPod by -clicking the button below: - -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/temporalio/edu-102-python-code) - -Alternatively, you can follow -[these instructions](https://learn.temporal.io/getting_started/python/dev_environment/) to -set up your own Temporal Cluster with Docker Compose, which you can use as an -exercise environment. +However, the packages are already installed, so there is no need to run pip again. \ No newline at end of file diff --git a/codespaces.md b/codespaces.md new file mode 100644 index 0000000..cfb74e0 --- /dev/null +++ b/codespaces.md @@ -0,0 +1,59 @@ +# Launching a Codespace + +GitHub Codespaces is a browser environment that can be used to complete the exercises from this course without needing to install anything on your local machine. This `codespaces.md` document will explain how to launch and configure the Codespaces environment. + +To launch the codespace, click on the green "Code" drop-down menu in the top-right corner of the repo display (to the left of the right-hand sidebar), navigate to the Codespaces sub-tab if it is not already focused, and click the **+** icon. + +![1 — Launch Codespace](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/1-launch-codespace.png) + +This will open a new tab containing a familiar VSCode-style interface. It may take up to a minute for the tab to populate, during which time "Opening Remote…" will be displayed in the bottom left corner. + +![2 — Loading Codespace](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/2-loading-codespace.png) + +Eventually, the Codespace will display the readme for the repo in the top two-thirds of the screen, and a Temporal Service running on the command line in the bottom third of the screen: + +![3 — Loaded Codespace](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/3-loaded-codespace.png) + +There are two things you’ll want to do before getting started: open the Web UI, and open some terminal windows to work in. + +### Opening the Web UI + +To open the Web UI, click on the "PORTS" tab near the middle of the screen (there may be a highlighted number next to it): + +![4 — Ports Tab](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/4-ports-tab.png) + +Then, on the row for Port 8080, Ctrl+click (Cmd+click on Mac) on the "Forwarded Address" link highlighted in blue like a regular URL: + +![5 — Port 8080 URL](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/5-port-8080-url.png) + +This will open the Temporal Web UI in a separate tab: + +![6 — Web UI](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/6-webui.png) + +You should navigate to this tab any time you need to access the Web UI. + +### Opening more Work Terminals + +To open some work terminals, navigate back to the Codespaces tab, and click on "TERMINAL" next to the "PORTS" tab that you clicked on earlier. + +![7 — Terminal Tab](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/7-terminal-tab.png) + +You should see "bash" in the right-hand sidebar. Click on "bash" to get a work terminal: + +![8 — Bash Terminal](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/8-bash-terminal.png) + +Then, to create more work terminals for this course – you’ll usually need 2 or 3 – use the drop-down arrow next to the "**+**" sign on top of where it says bash, and in that drop-down menu, navigate to "Split Terminal," and then "bash (Default)." + +![9 — Split Terminal](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/9-split-terminal.png) + +Repeat this for as many terminals as you need: + +![10 — Working Terminals](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/10-working-terminals.png) + +You’re all set. Don’t forget that you can Ctrl+click on the links displayed in the repo readme to open the readme for each individual exercise as you progress through the course: + +![11 — Exercise Readme](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/11-exercise-readme.png) + +Your Codespace will automatically be stopped 30 minutes after you close the browser tab. This is to prevent excessive resource utilization. It can be resumed from the same part of the Github UI if needed, within 30 days of the last time it was used. + +![12 — Resume Codespace](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/12-resume-codespace.png) \ No newline at end of file diff --git a/exercises/debug-activity/README.md b/exercises/debug-activity/README.md index 6abb7c7..da4831a 100644 --- a/exercises/debug-activity/README.md +++ b/exercises/debug-activity/README.md @@ -19,10 +19,6 @@ If you haven't already started the Translation Microservice used by this exercis do so in a separate terminal by navigating to `utilities/microservice` and running `python microservice.py`. -**Note: If you're using the Gitpod environment to run this exercise you can -skip this step. An instance of the Microservice is already running in your -environment** - ### Activate the Virtual Environment 1. Ensure that the virtual environment you setup at the beginning of the diff --git a/exercises/durable-execution/README.md b/exercises/durable-execution/README.md index f19dd0c..dec361d 100644 --- a/exercises/durable-execution/README.md +++ b/exercises/durable-execution/README.md @@ -15,10 +15,6 @@ Make your changes to the code in the `practice` subdirectory (look for `TODO` co If you haven't already started the Translation Microservice used by this exercise, do so in a separate terminal. -**Note: If you're using the Gitpod environment to run this exercise you can -skip this step. An instance of the Microservice is already running in your -environment** - ### Activate the Virtual Environment 1. Ensure that the virtual environment you setup at the beginning of the diff --git a/exercises/testing-code/README.md b/exercises/testing-code/README.md index 1489e4e..08fc81c 100644 --- a/exercises/testing-code/README.md +++ b/exercises/testing-code/README.md @@ -18,10 +18,6 @@ the complete version in the `solution` subdirectory. If you haven't already started the Translation Microservice used by this exercise, do so in a separate terminal. -**Note: If you're using the Gitpod environment to run this exercise you can -skip this step. An instance of the Microservice is already running in your -environment** - ### Activate the Virtual Environment 1. Ensure that the virtual environment you setup at the beginning of the diff --git a/samples/using-dataclasses-as-input-and-output/README.md b/samples/using-dataclasses-as-input-and-output/README.md index a89774c..b719855 100644 --- a/samples/using-dataclasses-as-input-and-output/README.md +++ b/samples/using-dataclasses-as-input-and-output/README.md @@ -8,10 +8,6 @@ and output data of Workflow and Activity Definitions. If you haven't already started the Translation Microservice used by this exercise, do so in a separate terminal. -**Note: If you're using the Gitpod environment to run this exercise you can -skip this step. An instance of the Microservice is already running in your -environment** - ### Activate the Virtual Environment 1. Ensure that the virtual environment you setup at the beginning of the From 0a47443cf9f35896f8296cf0a36b6f8a7df03752 Mon Sep 17 00:00:00 2001 From: angelazhou32 Date: Wed, 12 Mar 2025 10:32:40 -0400 Subject: [PATCH 2/2] adds codespaces --- README.md | 9 ++++++++- codespaces.md | 15 ++++++++++++++- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9af6ccc..d2eeb94 100644 --- a/README.md +++ b/README.md @@ -100,4 +100,11 @@ $ source env/bin/activate $ env\Scripts\activate ``` -However, the packages are already installed, so there is no need to run pip again. \ No newline at end of file +However, the packages are already installed, so there is no need to run pip again. + +## Exercise Environment for this Course + +You can launch an exercise environment for this course using GitHub Codespaces by +following [this](codespaces.md) walkthrough. + +Alternatively, you can perform these exercises directly on your computer. Refer to the instructions about setting up a local development environment, which you'll find in the "About this Course" chapter. diff --git a/codespaces.md b/codespaces.md index cfb74e0..ccc9942 100644 --- a/codespaces.md +++ b/codespaces.md @@ -12,7 +12,11 @@ This will open a new tab containing a familiar VSCode-style interface. It may ta Eventually, the Codespace will display the readme for the repo in the top two-thirds of the screen, and a Temporal Service running on the command line in the bottom third of the screen: +<<<<<<< HEAD ![3 — Loaded Codespace](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/3-loaded-codespace.png) +======= +![3 — Loaded Codespace](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/3-loaded-codespace.png) +>>>>>>> 0efc306 (adds codespaces) There are two things you’ll want to do before getting started: open the Web UI, and open some terminal windows to work in. @@ -56,4 +60,13 @@ You’re all set. Don’t forget that you can Ctrl+click on the links displayed Your Codespace will automatically be stopped 30 minutes after you close the browser tab. This is to prevent excessive resource utilization. It can be resumed from the same part of the Github UI if needed, within 30 days of the last time it was used. -![12 — Resume Codespace](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/12-resume-codespace.png) \ No newline at end of file +![12 — Resume Codespace](https://raw.githubusercontent.com/temporalio/temporal-learning/refs/heads/main/static/courses/common/codespaces/12-resume-codespace.png) + +### Delete Your Codespaces + +Once you are done with this course or the exercises, manually delete your codespaces. There are costs associated with storing codespaces. You should therefore delete any codespaces you no longer need. Here are the steps you need to take to delete your codespaces: + +1. Visit your codespaces page [here](https://github.com/codespaces). +2. To the right of the codespace you want to delete, click the three dots, then click `Delete`: + +![Delete codespace](https://learn.temporal.io/courses/common/codespaces/13-delete-codespaces.png "Delete codespace")