Skip to content

Getting started walkthrough for data scientists #18321

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.

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
merged 16 commits into from
Jan 24, 2022
Merged
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
91 changes: 63 additions & 28 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
"onCommand:python.launchTensorBoard",
"onCommand:python.clearPersistentStorage",
"onWalkthrough:pythonWelcome",
"onWalkthrough:pythonWelcomeWithDS",
"onWalkthrough:pythonDataScienceWelcome",
"workspaceContains:mspythonconfig.json",
"workspaceContains:pyproject.toml",
Expand Down Expand Up @@ -175,18 +176,19 @@
"media": {
"altText": "Image representing our documentation page and mailing list resources.",
"svg": "resources/walkthrough/learnmore.svg"
}
},
"when": ""
}
]
},
{
"id": "pythonDataScienceWelcome",
"title": "Get started with Python for Data Science",
"description": "Your first steps to getting started with a Data Science project with Python!",
"id": "pythonWelcomeWithDS",
"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.installPythonWinDS",
"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": {
Expand All @@ -195,7 +197,7 @@
"when": "workspacePlatform == windows"
},
{
"id": "python.installPythonMacDS",
"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": {
Expand All @@ -205,7 +207,7 @@
"command": "workbench.action.terminal.new"
},
{
"id": "python.installPythonLinuxDS",
"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": {
Expand All @@ -215,41 +217,74 @@
"command": "workbench.action.terminal.new"
},
{
"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)",
"id": "python.createPythonFile",
"title": "Create a Python file",
"description": "[Open](command:toSide:workbench.action.files.openFile) or [create](command:toSide:workbench.action.files.newUntitledFile) a Python file - make sure to save it as \".py\".\n[Create Python File](command:toSide:workbench.action.files.newUntitledFile)",
"media": {
"svg": "resources/walkthrough/open-folder.svg",
"altText": "Open a folder"
"altText": "Open a Python file or a folder with a Python project."
},
"completionEvents": [
"onCommand:workbench.action.files.openFileFolder"
],
"when": "workspacePlatform == mac && workspaceFolderCount == 0"
"when": ""
},
{
"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)",
"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)\n**Tip**: Run the ``Python: Select Interpreter`` command in the [Command Palette](command:workbench.action.showCommands).\nReload the window if you installed Python but don't see it in the list (``Developer: Reload Window`` command). ",
"media": {
"svg": "resources/walkthrough/open-folder.svg",
"altText": "Open a folder"
"svg": "resources/walkthrough/python-interpreter-v2.svg",
"altText": "Selecting a python interpreter from the status bar"
},
"completionEvents": [
"onCommand:workbench.action.files.openFolder"
],
"when": "workspacePlatform != mac && workspaceFolderCount == 0"
"when": ""
},
{
"id": "python.runAndDebug",
"title": "Run and debug your Python file",
"description": "Open your Python file and click on the play button on the top right of the editor, or press F5 when on the file and select \"Python File\" to run with the debugger. \n \n[Learn more](https://code.visualstudio.com/docs/python/python-tutorial#_run-hello-world)",
"media": {
"svg": "resources/walkthrough/rundebug2.svg",
"altText": "How to run and debug in VS Code with F5 or the play button on the top right."
},
"when": ""
},
{
"id": "python.learnMoreWithDS",
"title": "Explore more resources",
"description": "🎨 Explore all the features the Python extension has to offer by looking for \"Python\" in the [Command Palette](command:workbench.action.showCommands). \n 📈 Learn more about getting started with [data science](command:workbench.action.openWalkthrough?%7B%22category%22%3A%22ms-python.python%23pythonDataScienceWelcome%22%2C%22step%22%3A%22ms-python.python%23python.createNewNotebook%22%7D) in Python. \n 💌 [Sign up](https://aka.ms/python-vscode-mailinglist) for tips and tutorials through our mailing list. \n ✨ Take a look at our [Release Notes](https://aka.ms/AA8dxtb) to learn more about the latest features. \n \n[Learn More](https://aka.ms/AA8dqti)",
"media": {
"altText": "Image representing our documentation page and mailing list resources.",
"svg": "resources/walkthrough/learnmore.svg"
},
"when": ""
}
]
},
{
"id": "pythonDataScienceWelcome",
"title": "Get started with Python for Data Science",
"description": "Your first steps to getting started with a Data Science project with Python!",
"when": "false",
"steps": [
{
"id": "python.installJupyterExt",
"title": "Install Jupyter extension",
"description": "If you haven't already, install the [Jupyter extension](command:workbench.extensions.search?\"ms-toolsai.jupyter\") to take full advantage of notebooks experiences in VS Code!\n \n[Search Jupyter extension](command:workbench.extensions.search?\"ms-toolsai.jupyter\")",
"media": {
"svg": "resources/walkthrough/data-science.svg",
"altText": "Creating a new Jupyter notebook"
}
},
{
"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)",
"title": "Create or open a Jupyter Notebook",
"description": "Right click in the file explorer and create a new file with an .ipynb extension. Or, 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)\n If you have an existing project, you can also [open a folder](command:workbench.action.files.openFolder) and/or clone a project from GitHub: [clone a Git repository](command:git.clone).",
"media": {
"svg": "resources/walkthrough/create-notebook.svg",
"altText": "Creating a new Jupyter notebook"
},
"completionEvents": [
"onCommand:jupyter.createnewnotebook"
"onCommand:jupyter.createnewnotebook",
"onCommand:workbench.action.files.openFolder",
"onCommand:workbench.action.files.openFileFolder"
]
},
{
Expand All @@ -267,7 +302,7 @@
{
"id": "python.dataScienceLearnMore",
"title": "Find out 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 📒 Take a look into the [Jupyter extension](command:workbench.extensions.search?\"ms-toolsai.jupyter\") features, by looking for \"Jupyter\" in the [Command Palette](command:workbench.action.showCommands). \n 📃 Find out more features in our [Tutorials](https://aka.ms/AAdjzpd). \n[Learn more](https://aka.ms/AAdar6q)",
"description": "📒 Take a look into the [Jupyter extension](command:workbench.extensions.search?\"ms-toolsai.jupyter\") features, by looking for \"Jupyter\" in the [Command Palette](command:workbench.action.showCommands). \n 🏃🏻 Find out more features in our [Tutorials](https://aka.ms/AAdjzpd). \n[Learn more](https://aka.ms/AAdar6q)",
"media": {
"svg": "resources/walkthrough/learnmore.svg",
"altText": "Image representing our documentation page and mailing list resources."
Expand Down