Skip to content

Dev guide: modernize Python install guidance for shell developers #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nahumtimerman merged 1 commit into from
Sep 6, 2026
Merged

Dev guide: modernize Python install guidance for shell developers #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/devguide/developing-shells/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Run the following in your local Command Line:
python -m pip install shellfoundry
```

For windows users, it is recommended to add the path (to the shellfoundry installation folder) to your local environment variables. For example, C:\\Python27\\Scripts. This will enable us to run the Shellfoundry commands from any folder of the Shell project.
For windows users, it is recommended to add the path (to the shellfoundry installation folder) to your local environment variables. For example, C:\\Python313\\Scripts. This will enable us to run the Shellfoundry commands from any folder of the Shell project.

**To update Shellfoundry:**

Expand Down
6 changes: 4 additions & 2 deletions docs/devguide/setting-up-dev-env.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ sidebar_position: 1

In this section we’ll go over the recommended steps for setting up a development environment for developing CloudShell Shells and orchestration scripts.

## Get the latest Python 3.9.x
## Install Python

![Python](/Images/Devguide-intro/Intro-Setting-up-the-Development.png)

Download and install the latest version of Python 3.9.x from the [official website](https://www.python.org/downloads/). We also recommend installing pip (even though technically its included in the latest versions of Python): pip 21.2.4 and up for Python 3.7 and pip 19.2.3 for Python 2.7.18. Python 2.7.x is supported for older shells. Follow the instructions on this website: [https://pip.pypa.io/en/stable/installing/](https://pip.pypa.io/en/stable/installing/)
Download and install a current 64-bit version of Python 3 from the [official website](https://www.python.org/downloads/). Shellfoundry, CloudShell's shell development CLI, supports Python 3.9–3.13 (Python 3.13 requires shellfoundry 1.2.29 or later).

Note that shells and scripts *execute* on the Python versions bundled with CloudShell itself — currently Python 3.9.9 (and Python 2.7.18 for legacy shells). Your driver code and its requirements.txt must stay compatible with the bundled version your CloudShell deployment runs, even if your dev machine uses a newer Python.
:::tip
CloudShell components such as Quali Server and the execution servers come with their own Python installation folders. Making changes to these folders may cause unexpected behavior in CloudShell. Therefore, if you plan on doing dev work on a machine that has CloudShell components installed, we recommend doing one of the following:

Expand Down
Loading