Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions docs/python/python-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Get started by installing:
- [A Python Interpreter](/docs/python/python-tutorial.md#_install-a-python-interpreter) (any [actively supported Python version](https://devguide.python.org/versions/))
- [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) from the VS Code Marketplace

> [!TIP]
> **Understanding the Python components:**
> * **Visual Studio Code (The Editor)**: This is where you write and edit your code files. It does not run Python on its own.
> * **The Python Extension (The Helper)**: Installed inside VS Code, it adds Python features like autocomplete, debugging, and testing.
> * **The Python Interpreter (The Runner)**: The engine installed on your computer that actually executes your Python program.
>
> *Note: If you are installing Python for the first time, you must **restart your terminal/command prompt** (close your current terminal/VS Code and open a new one) so your system detects the newly installed interpreter.*

![Gif installing the Python extension in a fresh install of VS Code](images/quick-start/qs-python-ext-install.gif)

To further customize VS Code for Python, you can leverage the [Python profile template](/docs/configure/profiles.md#python-profile-template), automatically installing recommended extensions and settings. For Data Science projects, consider using the [Data Science profile template](/docs/configure/profiles.md#data-science-profile-template).
Expand Down
16 changes: 16 additions & 0 deletions docs/python/python-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,16 @@ To successfully complete this tutorial, you need to first set up your Python dev
- [VS Code](https://code.visualstudio.com/)
- [VS Code Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) (For additional details on installing extensions, see [Extension Marketplace](/docs/configure/extensions/extension-marketplace.md))

## Understanding the Python development stack

If you are new to programming, you might wonder why you need to install multiple things. It helps to understand the three distinct components of your setup:

* **Visual Studio Code (The Editor)**: This is your workspace—a powerful text editor where you write, read, and manage your code files. It does not run your code on its own.
* **The Python Extension (The Helper)**: This is an add-on you install inside VS Code. It teaches the editor how to understand Python, providing features like autocomplete (IntelliSense), code formatting, and debugging tools.
* **The Python Interpreter (The Runner)**: This is the actual engine installed on your computer that reads your Python code and translates it so your computer can execute it.

Think of VS Code as a kitchen, the Python extension as the recipe book that helps you cook, and the Python interpreter as the stove that actually cooks the food.

## Install a Python interpreter

Along with the Python extension, you need to install a Python interpreter. Which interpreter you use is dependent on your specific needs, but some guidance is provided below.
Expand Down Expand Up @@ -63,6 +73,12 @@ The built-in Python 3 installation on Linux works well, but to install other Pyt
>If the installation was successful, the output window should show the version of Python that you installed.
>Alternatively, you can use the `py -0` command in the VS Code integrated terminal to view the versions of python installed on your machine. The default interpreter is identified by an asterisk (*).

> [!NOTE]
> **What is a "Shell" or "Terminal"?**
> You will often see references to a "shell" or "terminal prompt" in programming guides. A shell (or terminal) is a text-based interface that allows you to run commands on your computer (like Command Prompt or PowerShell on Windows, and Terminal on macOS or Linux).
>
> **Why restart it?** When you install Python for the first time, your computer updates its internal list of available tools (called the `PATH` environment variable). To make sure your terminal/shell detects the newly installed Python interpreter, you must **restart** it. You can do this simply by closing your current VS Code window or terminal application, and opening a new one.

## Start VS Code in a workspace folder

By starting VS Code in a folder, that folder becomes your "workspace".
Expand Down