Add new getting started page

news/1 Enhancements/16678.md

@@ -0,0 +1 @@
+Add new getting started page using VS Code's API

package.json

@@ -102,6 +102,163 @@
     ],
     "main": "./out/client/extension",
     "contributes": {
+        "walkthroughs": [
+            {
+                "id": "pythonWelcome",
+                "title": "Get started with Python development",
+                "description": "Your first steps to set up a Python project with all the powerful tools and features that the Python extension has to offer!",
+                "when": "false",
+                "steps": [
+                    {
+                        "id": "python.installPythonWin",
+                        "title": "Install Python",
+                        "description": "The Python Extension requires Python to be installed. Install Python from the [Microsoft Store](https://aka.ms/AAd9rms).\n\n[Install Python](https://aka.ms/AAd9rms)\n",
+                        "media": {
+                            "markdown": "resources/walkthrough/install-python-windows.md"
+                        },
+                        "when": "workspacePlatform == windows"
+                    },
+                    {
+                        "id": "python.installPythonMac",
+                        "title": "Install Python",
+                        "description": "The Python Extension requires Python to be installed. Install Python 3 through the terminal.\n[Open Terminal](command:workbench.action.terminal.new)\n",
+                        "media": {
+                            "markdown": "resources/walkthrough/install-python-macos.md"
+                        },
+                        "when": "workspacePlatform == mac",
+                        "command": "workbench.action.terminal.new"
+                    },
+                    {
+                        "id": "python.installPythonLinux",
+                        "title": "Install Python",
+                        "description": "The Python Extension requires Python to be installed. Install Python 3 through the terminal.\n[Open Terminal](command:workbench.action.terminal.new)\n",
+                        "media": {
+                            "markdown": "resources/walkthrough/install-python-linux.md"
+                        },
+                        "when": "workspacePlatform == linux",
+                        "command": "workbench.action.terminal.new"
+                    },
+                    {
+                        "id": "python.selectInterpreter",
+                        "title": "Select a Python Interpreter",
+                        "description": "Choose which Python interpreter/environment you want to use for your Python project.\n[Select Python Interpreter](command:python.setInterpreter)\nTip: Reload the window if you installed Python but don't see it in the list (``Developer: Reload Window`` command in the [Command Palette](command:workbench.action.showCommands))",
+                        "media": {
+                            "altText": "selecting a python interpreter from the status bar",
+                            "image": {
+                                "dark": "resources/walkthrough/change-python-interpreter-dark.gif",
+                                "light": "resources/walkthrough/change-python-interpreter-light.gif",
+                                "hc": "resources/walkthrough/change-python-interpreter-hc.gif"
+                            }
+                        },
+                        "when": ""
+                    },
+                    {
+                        "id": "python.runAndDebug",
+                        "title": "Run and debug your Python file",
+                        "description": "Open your Python file, press F5 and select 'Python File' to start running and debugging. \n[Learn more](https://code.visualstudio.com/docs/python/python-tutorial#_run-hello-world)",
+                        "media": {
+                            "markdown": "resources/walkthrough/run-and-debug-python-file.md"
+                        },
+                        "when": "workspacePlatform != mac"
+                    },
+                    {
+                        "id": "python.runAndDebugMacOS",
+                        "title": "Run and debug your Python file",
+                        "description": "Open your Python file, press F5 and select 'Python File' to start running and debugging. \n[Learn more](https://code.visualstudio.com/docs/python/python-tutorial#_run-hello-world)",
+                        "media": {
+                            "markdown": "resources/walkthrough/run-and-debug-python-file-macOS.md"
+                        },
+                        "when": "workspacePlatform == mac"
+                    },
+                    {
+                        "id": "python.learnMore",
+                        "title": "Learn more",
+                        "description": "• Explore all the features the Python extension has to offer by looking for \"Python\" in the [Command Palette](command:workbench.action.showCommands).\n• [Sign up](https://aka.ms/python-vscode-mailinglist) for tips and tutorials through our mailing list.\n• Explore more features in our [Tutorials](https://aka.ms/AA8dqti) or check [Documentation](https://aka.ms/AA8dxwy) for tips and troubleshooting.\n• Take a look at our [Release Notes](https://aka.ms/AA8dxtb) to learn more about the latest features.",
+                        "media": {
+                            "image": "resources/walkthrough/python-docs-learn-more.png",
+                            "altText": "Documentation page for Python in VS Code"
+                        }
+                    }
+                ]
+            },
+            {
+                "id": "pythonDataScienceWelcome",
+                "title": "Get started with Python for Data Science",
+                "description": "Your first steps to getting started with a Python Data Science project!",
+                "when": "false",
+                "steps": [
+                    {
+                        "id": "python.installPython",
+                        "title": "Install Python",
+                        "description": "The Python Extension requires Python to be installed. Install Python from [Anaconda](https://www.anaconda.com) to use the Python extension.\n \n[Install Python with Anaconda](command:workbench.action.reloadWindow)",
+                        "media": {
+                            "image": "resources/walkthrough/anaconda-install.png",
+                            "altText": "Screenshot of anaconda webpage"
+                        },
+                        "when": ""
+                    },
+                    {
+                        "id": "python.openFolderMac",
+                        "title": "Open an existing Python project",
+                        "description": "If you already have an existing Python project on your machine:\n[Open Folder](command:workbench.action.files.openFileFolder)\n \nIf you would like to clone a Python project from GitHub:\n[Clone a Git repository](command:git.clone)",
+                        "media": {
+                            "image": "images/OpenOrCreateNotebook.gif",
+                            "altText": "Open a folder"
+                        },
+                        "completionEvents": [
+                            "onCommand:workbench.action.files.openFileFolder"
+                        ],
+                        "when": "workspacePlatform == mac && workspaceFolderCount == 0"
+                    },
+                    {
+                        "id": "python.openFolder",
+                        "title": "Open an existing Python project",
+                        "description": "To start, open a Python folder/project.\nIf you already have an existing Python project on your machine:\n[Open Folder](command:workbench.action.files.openFolder)\n \nIf you would like to clone a Python project from GitHub:\n[Clone a Git repository](command:git.clone)",
+                        "media": {
+                            "image": "images/OpenOrCreateNotebook.gif",
+                            "altText": "Open a folder"
+                        },
+                        "completionEvents": [
+                            "onCommand:workbench.action.files.openFolder"
+                        ],
+                        "when": "workspacePlatform != mac && workspaceFolderCount == 0"
+                    },
+                    {
+                        "id": "python.createNewNotebook",
+                        "title": "Create a new Jupyter Notebook",
+                        "description": "To create a new Jupyter Notebook, you can right click in the file explorer and create a new file with an .ipynb extension anytime.\n \nAlternatively, you can open the [Command Palette](command:workbench.action.showCommands) and run the command \n``Jupyter: Create New Blank Notebook``.\n[Create new Jupyter Notebook](command:toSide:jupyter.createnewnotebook)",
+                        "media": {
+                            "image": "resources/walkthrough/new-notebook.png",
+                            "altText": "Creating a new Jupyter notebook"
+                        },
+                        "completionEvents": [
+                            "onCommand:jupyter.createnewnotebook"
+                        ]
+                    },
+                    {
+                        "id": "python.openInteractiveWindow",
+                        "title": "Open the Python Interactive Window",
+                        "description": "The Python Interactive Window is a Python shell where you can execute and view the results of your Python code. You can create cells on a Python file by typing ``#%%``.\n \nTo open the interactive window anytime, open the [Command Palette](command:workbench.action.showCommands) and run the command \n``Jupyter: Create Interactive Window``.\n[Open Interactive Window](command:toSide:jupyter.createnewinteractive)",
+                        "media": {
+                            "image": "resources/walkthrough/interactive-window.png",
+                            "altText": "Opening python interactive window"
+                        },
+                        "completionEvents": [
+                            "onCommand:jupyter.createnewinteractive"
+                        ]
+                    },
+                    {
+                        "id": "python.dataScienceLearnMore",
+                        "title": "Learn more",
+                        "description": "• Explore all the features the Python extension has to offer by looking for \"Python\" in the [Command Palette](command:workbench.action.showCommands).\n• [Sign up](https://aka.ms/python-vscode-mailinglist) for tips and tutorials through our mailing list.\n• Explore more features in our [Tutorials](https://aka.ms/AA8dqti) or check the [Documentation](https://aka.ms/AA8dxwy) for tips and troubleshooting.\n• Take a look at our [Release Notes](https://aka.ms/AA8dxtb) to learn more about the latest features.",
+                        "media": {
+                            "image": "resources/walkthrough/datascience-learn-more.png",
+                            "altText": "Learning more from python visual studio code documentation"
+                        }
+                    }
+                ]
+            }
+        ],
         "breakpoints": [
             {
                 "language": "html"

resources/walkthrough/install-python-linux.md

@@ -0,0 +1,22 @@
+# Install Python on Linux
+
+To install the latest version of Python on [Debian-based Linux distributions](https://www.debian.org/), you can create a new terminal (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>`</kbd>) and run the following commands:
+
+
+```
+sudo apt-get update
+sudo apt-get install python3 python3-venv python3-pip
+```
+
+For [Fedora-based Linux distributions](https://getfedora.org/), you can run the following:
+
+```
+sudo dnf install python3
+```
+
+To verify if Python was successfully installed, run the following command in the terminal:
+
+
+```
+python3 --version
+```

resources/walkthrough/install-python-macos.md

@@ -0,0 +1,15 @@
+# Install Python on macOS
+
+If you have [Homebrew](https://brew.sh/) installed, you can install Python by running the following command in the terminal (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>`</kbd>):
+
+```
+brew install python
+```
+
+If you don't have Homebrew, you can download a Python installer for macOS from [python.org](https://www.python.org/downloads/mac-osx/).
+
+To verify if Python was successfully installed, run the following command in the terminal:
+
+```
+python3 --version
+```

resources/walkthrough/install-python-windows.md

@@ -0,0 +1,14 @@
+## Install Python on Windows
+
+If you don't have Python installed on your Windows machine, you can install it from the [Microsoft Store](https://aka.ms/AAd9rms).
+
+To verify it's installed, create a new terminal (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>`</kbd>) and try running the following command:
+
+```
+python --version
+```
+
+You should see something similar to the following:
+```
+Python 3.9.5
+```

resources/walkthrough/learn-more.md

@@ -0,0 +1,4 @@
+
+- [Signup](https://aka.ms/AAAbopxr) for tips and tutorials through our mailing list.
+- Explore more features in our [Tutorials](https://aka.ms/AA8dqti) or check [Documentation](https://aka.ms/AA8dxwy) for tips and troubleshooting.
+- Take a look at our [Release Notes](https://aka.ms/AA8dxtb) to learn more about the latest features.

resources/walkthrough/run-and-debug-python-file-macOS.md

@@ -0,0 +1,11 @@
+# Run and debug your Python file
+
+To run and debug your Python file, you can follow the steps below:
+
+1. [Open](command:workbench.action.files.openFileFolder) your Python file (<kbd>Cmd</kbd> + <kbd>O</kbd>) in Visual Studio Code.
+
+2. To run your file using the Python interpreter, you can click on the play button on the top right of the editor.
+
+    <img src="play-button-dark.png"  scale=0.5>
+
+3. To debug your file,  press <kbd>F5</kbd> and select 'Python File'. You can also open the Run and Debug view (<kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>D</kbd>) and click on the `Run and Debug` button.

resources/walkthrough/run-and-debug-python-file.md

@@ -0,0 +1,11 @@
+# Run and debug your Python file
+
+To run and debug your Python file, you can follow the steps below:
+
+1. [Open](command:workbench.action.files.openFile) your Python file (<kbd>Ctrl</kbd> + <kbd>O</kbd>) in Visual Studio Code.
+
+2. To run your file using the Python interpreter, you can click on the play button on the top right of the editor.
+
+    <img src="play-button-dark.png"  scale=0.5>
+
+3. To debug your file,  press <kbd>F5</kbd> and select 'Python File'. You can also open the Run and Debug view (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>D</kbd>) and click on the `Run and Debug` button.