Add Python Quick Start page (microsoft#6951)

cwebster-99 · luabud · ntrogh · web-flow · commit 32cf423e3e72 · 2024-01-18T19:27:49.000+01:00
* Initial commit adding the Python Quick Start

* Apply suggestions from code review

Co-authored-by: Luciana Abud &lt;45497113+luabud@users.noreply.github.com&gt;

* Removing some expanded sections for brevity

* Updating images and gifs

* Apply suggestions from code review

Co-authored-by: Luciana Abud &lt;45497113+luabud@users.noreply.github.com&gt;

* Updating media

* new debug gif

* Apply suggestions from code review

Co-authored-by: Nick Trogh &lt;1908215+ntrogh@users.noreply.github.com&gt;

* Update sitemap for new Python quickstart

* Update docs/python/python-quick-start.md

* Updating debug gif

* Update docs/python/python-quick-start.md

Co-authored-by: Courtney Webster &lt;60238438+cwebster-99@users.noreply.github.com&gt;

---------

Co-authored-by: Luciana Abud &lt;45497113+luabud@users.noreply.github.com&gt;
Co-authored-by: Nick Trogh &lt;1908215+ntrogh@users.noreply.github.com&gt;
diff --git a/build/sitemap.xml b/build/sitemap.xml
@@ -580,6 +580,11 @@
         <changefreq>weekly</changefreq>
         <priority>0.8</priority>
     </url>
+    <url>
+        <loc>https://code.visualstudio.com/docs/python/python-quick-start</loc>
+        <changefreq>weekly</changefreq>
+        <priority>0.8</priority>
+    </url>
     <url>
         <loc>https://code.visualstudio.com/docs/python/python-tutorial</loc>
         <changefreq>weekly</changefreq>
diff --git a/docs/python/debugging.md b/docs/python/debugging.md
@@ -1,5 +1,5 @@
 ---
-Order: 5
+Order: 6
 Area: python
 TOCTitle: Debugging
 ContentId: 3d9e6bcf-eae8-4c94-b857-89225b5c4ab5
diff --git a/docs/python/editing.md b/docs/python/editing.md
@@ -1,5 +1,5 @@
 ---
-Order: 2
+Order: 3
 Area: python
 TOCTitle: Editing Code
 ContentId: 0ccb0e35-c4b2-4001-91bf-79ff1618f601
diff --git a/docs/python/environments.md b/docs/python/environments.md
@@ -1,5 +1,5 @@
 ---
-Order: 6
+Order: 7
 Area: python
 TOCTitle: Environments
 ContentId: 8fe4ca8b-fc70-4216-86c7-2c11b6c14cc6
diff --git a/docs/python/formatting.md b/docs/python/formatting.md
@@ -1,5 +1,5 @@
 ---
-Order: 4
+Order: 5
 Area: python
 TOCTitle: Formatting
 ContentId: c5039182-eee4-47ff-a2a8-dc28f4bc2cbc
diff --git a/docs/python/images/quick-start/breakpoint.png b/docs/python/images/quick-start/breakpoint.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:153eb6501c39ba108c71b8944413d2cb8825fd385c426a4a81549f286a6eb3c9
+size 110561
diff --git a/docs/python/images/quick-start/cmd-plt-resize-v2.gif b/docs/python/images/quick-start/cmd-plt-resize-v2.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c588c63583d4e217926ef678c208480b36868660f0aab85fec3c8dc81c5b9ab0
+size 196358
diff --git a/docs/python/images/quick-start/cmd-plt-v2.gif b/docs/python/images/quick-start/cmd-plt-v2.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ae3acf7c07758122b38a8da250081843e8efc0c5a4e676da4e1d017f525a4b21
+size 617922
diff --git a/docs/python/images/quick-start/python-ext-install-resize.gif b/docs/python/images/quick-start/python-ext-install-resize.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e7775c75a9f06a78a62c7ef373ddfe4d5659dc79833bd12d1eaeb407476f55db
+size 398829
diff --git a/docs/python/images/quick-start/python-profile-create.gif b/docs/python/images/quick-start/python-profile-create.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:db032be316b46cbfbd6096e962a4b2562b73e22a1f15a33ad96094fd0207ee74
+size 976376
diff --git a/docs/python/images/quick-start/python-profile-resize.gif b/docs/python/images/quick-start/python-profile-resize.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8d2970d4f0c46b284f09ba8a4163b3a118cb948634ef4785d5099ac02f4e6035
+size 612523
diff --git a/docs/python/images/quick-start/qs-debug-v2.gif b/docs/python/images/quick-start/qs-debug-v2.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:92599dd0edf2f7639bdef43f920403bdd580a3ac2f310f232ef182e1f517bdad
+size 1667777
diff --git a/docs/python/images/quick-start/qs-python-debug.gif b/docs/python/images/quick-start/qs-python-debug.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0d0b47388fb417944303b41041e8960b362954eca18318392fce180ded06acd0
+size 1236828
diff --git a/docs/python/images/quick-start/qs-python-ext-install.gif b/docs/python/images/quick-start/qs-python-ext-install.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:68b2a89c222e72e0259435c6dae1c61c245b210f58c5c97c0bf018d9a3a312da
+size 644233
diff --git a/docs/python/images/quick-start/qs-testing.gif b/docs/python/images/quick-start/qs-testing.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:318ccfebdf36c8d2fc7e9c472cfe32606919d31b5f7a6ca85518932e8b281c35
+size 1077515
diff --git a/docs/python/images/quick-start/ui-tour.png b/docs/python/images/quick-start/ui-tour.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4d8a8c1b466be7658d222b168e9bf07dd07b5b9bceb538db5e6e47800b147760
+size 278413
diff --git a/docs/python/jupyter-support-py.md b/docs/python/jupyter-support-py.md
@@ -1,5 +1,5 @@
 ---
-Order: 8
+Order: 9
 Area: python
 TOCTitle: Python Interactive
 ContentId: C26E4F82-C6CD-4C52-818F-31A95F58207E
diff --git a/docs/python/linting.md b/docs/python/linting.md
@@ -1,5 +1,5 @@
 ---
-Order: 3
+Order: 4
 Area: python
 TOCTitle: Linting
 ContentId: 0ccb0e35-c4b2-4001-91bf-79ff1618f601
diff --git a/docs/python/python-on-azure.md b/docs/python/python-on-azure.md
@@ -1,5 +1,5 @@
 ---
-Order: 13
+Order: 14
 Area: python
 TOCTitle: Deploy Python Apps
 ContentId: 12bf713e-5f20-46ac-81bb-8e05565aba3a
diff --git a/docs/python/python-quick-start.md b/docs/python/python-quick-start.md
@@ -0,0 +1,112 @@
+---
+Order: 1
+Area: python
+TOCTitle: Quick Start
+ContentId: c7134463-4fdd-4674-8685-77c94472902c
+PageTitle: Quick Start Guide for Python in VS Code
+DateApproved: 1/17/2024
+MetaDescription: A quick start guide to get you up and coding with the Python extension in Visual Studio Code.
+MetaSocialImage: images/tutorial/social.png
+---
+
+# Quick Start Guide for Python in VS Code
+
+The Python extension makes Visual Studio Code an excellent Python editor, works on any operating system, and is usable with a variety of Python interpreters.
+
+Get started by installing:
+-	[VS Code](https://code.visualstudio.com/)
+-	[A Python Interpreter](/docs/python/python-tutorial.md#_install-a-python-interpreter) (any [actively supported Python version](https://devguide.python.org/#status-of-python-branches))
+-	[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) from the VS Code Marketplace
+
+![Gif installing the Python extension in a fresh install of VS Code](/docs/python/images/quick-start/qs-python-ext-install.gif)
+
+To further customize VS Code for Python, you can leverage the [Python profile template](/docs/editor/profiles.md#python-profile-template), automatically installing recommended extensions and settings. For Data Science projects, consider using the [Data Science profile template](/docs/editor/profiles.md#data-science-profile-template).
+
+![Gif showing the Python profile template being installing into VS Code.](/docs/python/images/quick-start/python-profile-create.gif)
+
+## How to create and open a Python project or file
+
+If you have an existing Python project you wish to work on in VS Code, you can begin by opening your folder or file from the VS Code Welcome page or File Explorer view, or by selecting **File > Open Folder** (`kb(workbench.action.files.openFolder)`) or **File > Open File** (`kb(workbench.action.files.openFile)`).
+
+You can create a new Python file by selecting **New File** on the VS Code Welcome page and then selecting **Python file**, or by navigating to **File > New File** (`kb(workbench.action.files.newFile)`).
+
+> **Tip:** If you already have a workspace folder open in VS Code, you can add new files or folders directly into your existing project. You can create new folders and files by using the corresponding **New Folder** or **New File** icons on the top level folder in the File Explorer view.
+
+## UI tour
+
+When you launch VS Code for the very first time, you will need to install the Python extension to get Python-specific features and UI. Let’s look at the UI after installing the Python extension:
+
+![Image of the Python UI highlights in VS Code.](/docs/python/images/quick-start/ui-tour.png)
+
+## Code Actions
+
+Code Actions (also known as Quick Fixes) are provided to help fix issues when there are warnings in your code. These helpful hints are displayed in the editor left margin as a lightbulb (💡). Select the light bulb to display Code Action options. These Code Action can come from extensions such as Python, Pylance, or VS Code itself. For more information about Code Actions, see [Python Quick Fixes](/docs/python/editing.md#quick-fixes).
+
+![Gif showing Code Actions in a Python project.](images/editing/quickFix.gif)
+
+## Python commands
+
+Python commands can be accessed through the [Command Palette](/docs/getstarted/userinterface.md#command-palette) (`kb(workbench.action.showCommands)`). From the Command Palette, you have access to various features from VS Code and installed extensions. Enter **“Python: “** in the Command Palette to find the commands available through the Python extension.
+
+![Gif demonstrating how to access Python commands in the Command Palette.](/docs/python/images/quick-start/cmd-plt-v2.gif)
+
+## Run, debug, and test
+
+Now that you are more familiar with Python in VS Code, let’s learn how to run, debug, and test your code.
+
+### Run
+
+There are a few ways to run Python code in VS Code.
+
+To run the Python script you have open on the editor, select the **Run Python File in Terminal** play button in the top-right of the editor.
+
+![Image showing the Run Python File in Terminal play button.](images/tutorial/run-python-file-in-terminal-button.png)
+
+There are also additional ways you can iteratively run snippets of your Python code within VS Code:
+-	Select one or more lines, then press `kbstyle(Shift+Enter)` or right-click and select **Run Selection/Line in Python Terminal**. This command is convenient for testing just a part of a file.
+-	From the Command Palette (`kb(workbench.action.showCommands)`), select the **Python: Start REPL** command to open a REPL terminal for the currently selected Python interpreter. In the REPL, you can then enter and run lines of code one at a time.
+
+### Debug
+
+The debugger is a helpful tool that allows you to inspect the flow of your code execution and more easily identify errors, as well as explore how your variables and data change as your program is run. You can start debugging by setting a breakpoint in your Python project by clicking in the gutter next to the line you wish to inspect.
+
+![Screenshot showing a debugger breakpoint in a Python program.](/docs/python/images/quick-start/breakpoint.png)
+
+To start debugging, initialize the debugger by pressing `kbstyle(F5)`. Since this is your first time debugging this file, a configuration menu will open allowing you to select the type of application you want to debug. If it's a Python script, you can select **Python File**.
+
+Once your program reaches the breakpoint, it will stop and allow you to track data in the Python Debug console, and progress through your program using the debug toolbar.
+
+![Gif showing how to configure the Python debugger for the first time.](images/quick-start/qs-debug-v2.gif)
+
+For a deeper dive into Python debugging functionality, see [Python debugging in VS Code](/docs/python/debugging.md).
+
+### Test
+The Python extension provides robust testing support for [Unittest](https://docs.python.org/3.3/library/unittest.html) and [pytest](https://pytest.org/en/7.4.x/).
+
+You can configure Python tests through the Testing view on the Activity Bar by selecting **Configure Python Tests** and selecting your test framework of choice.
+
+You can also create tests for your Python project, which the Python extension will attempt to discover once your framework of choice is configured. The Python extension also allows you to run and debug your tests in the Testing view and inspect the test run output in the Test Results panel.
+
+![Gif demonstrating test configuration, discovery, and run in the Python extension.](/docs/python/images/quick-start/qs-testing.gif)
+
+For a comprehensive look at testing functionality, see [Python testing in VS Code](/docs/python/testing.md).
+
+## Next steps
+
+To learn how to build web apps with popular Python web frameworks, see the following tutorials:
+
+- [Use Django in Visual Studio Code](/docs/python/tutorial-django.md)
+- [Use Flask in Visual Studio Code](/docs/python/tutorial-flask.md)
+- [Use FastAPI in Visual Studio Code](/docs/python/tutorial-fastapi.md)
+
+There is much more to explore with Python in Visual Studio Code:
+
+- [Python profile template](/docs/editor/profiles.md#python-profile-template) - Create a new [profile](/docs/editor/profiles) with a curated set of extensions, settings, and snippets
+- [Editing code](/docs/python/editing.md) - Learn about autocomplete, IntelliSense, formatting, and refactoring for Python.
+- [Linting](/docs/python/linting.md) - Enable, configure, and apply a variety of Python linters.
+- [Debugging](/docs/python/debugging.md) - Learn to debug Python both locally and remotely.
+- [Testing](/docs/python/testing.md) - Configure test environments and discover, run, and debug tests.
+- [Settings reference](/docs/python/settings-reference.md) - Explore the full range of Python-related settings in VS Code.
+
+
+
diff --git a/docs/python/python-tutorial.md b/docs/python/python-tutorial.md
@@ -1,5 +1,5 @@
 ---
-Order: 1
+Order: 2
 Area: python
 TOCTitle: Tutorial
 ContentId: 77828f36-ae45-4887-b25c-34545edd52d3
diff --git a/docs/python/python-web.md b/docs/python/python-web.md
@@ -1,5 +1,5 @@
 ---
-Order: 14
+Order: 15
 Area: python
 TOCTitle: Python in the Web
 ContentId: 366e4bbf-fa87-4813-9dfc-6c831b20a4d2
diff --git a/docs/python/settings-reference.md b/docs/python/settings-reference.md
@@ -1,5 +1,5 @@
 ---
-Order: 15
+Order: 16
 Area: python
 TOCTitle: Settings Reference
 ContentId: d256dc5c-95e9-4c02-a82f-947bf34a3517
diff --git a/docs/python/testing.md b/docs/python/testing.md
@@ -1,5 +1,5 @@
 ---
-Order: 7
+Order: 8
 Area: python
 TOCTitle: Testing
 ContentId: 9480bef3-4dfc-4671-a454-b9252567bc60
diff --git a/docs/python/tutorial-create-containers.md b/docs/python/tutorial-create-containers.md
@@ -1,5 +1,5 @@
 ---
-Order: 12
+Order: 13
 Area: python
 TOCTitle: Create containers
 ContentId: 4e45a3f6-b72d-4647-82a5-22f7ee593d47
diff --git a/docs/python/tutorial-django.md b/docs/python/tutorial-django.md
@@ -1,5 +1,5 @@
 ---
-Order: 9
+Order: 10
 Area: python
 TOCTitle: Django Tutorial
 ContentId: 3c0948f9-85a5-4dd4-a461-59788dbfce4c
diff --git a/docs/python/tutorial-fastapi.md b/docs/python/tutorial-fastapi.md
@@ -1,5 +1,5 @@
 ---
-Order: 10
+Order: 11
 Area: python
 TOCTitle: FastAPI Tutorial
 ContentId: 0d32bced-91aa-5c2e-e569-6fc7995370ae
diff --git a/docs/python/tutorial-flask.md b/docs/python/tutorial-flask.md
@@ -1,5 +1,5 @@
 ---
-Order: 11
+Order: 12
 Area: python
 TOCTitle: Flask Tutorial
 ContentId: 593d2dd6-20f0-4ad3-8ecd-067cc47ee217
