From 1685ef04fac61067a114c8abc80610e993aec9f3 Mon Sep 17 00:00:00 2001 From: claudiaregio Date: Thu, 5 Nov 2020 17:00:23 -0800 Subject: [PATCH 1/9] remove refactoring from description --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 070962b36fb..ffe51a43699 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "jupyter", "displayName": "Jupyter", - "description": "Language-agnostic jupyter notebook, interactive programming and computing that supports Intellisense, code formatting, refactoring, debugging and more.", + "description": "Language-agnostic jupyter notebook, interactive programming and computing that supports Intellisense, refactoring, debugging and more.", "version": "2020.12.0-dev", "featureFlags": { "usingNewInterpreterStorage": true From 05074ec94b9a1aebd959a54ebe1d97c577297e61 Mon Sep 17 00:00:00 2001 From: claudiaregio Date: Mon, 9 Nov 2020 17:07:08 -0800 Subject: [PATCH 2/9] Updated Jupyter ReadMe --- README.md | 72 ++++++++++++++++++++++++------------------------------- 1 file changed, 31 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 5370d504045..e7a2e286e46 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,38 @@ -# Jupyter extension for Visual Studio Code +# Jupyter Extension for Visual Studio Code Insiders -A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marketplace.visualstudio.com/VSCode) with rich support for the [Python language](https://www.python.org/) (for all [actively supported versions](https://devguide.python.org/#status-of-python-branches) of the language: 2.7, >=3.6), including features such as IntelliSense, linting, debugging, code navigation, code formatting, Jupyter notebook support, refactoring, variable explorer, test explorer, snippets, and more! +A [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/) [extension](https://marketplace.visualstudio.com/VSCode) with support for [Jupyter Notebooks](https://www.python.org/) (working towards supporting all [actively supported kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels)), including features such as IntelliSense, debugging, and more! + +\*If working in VS Code Stable, please see the [Python Extension ReadMe](https://github.com/microsoft/vscode-python/blob/main/README.md) or the [Python Documentation](https://code.visualstudio.com/docs/python/jupyter-support). ## Quick start -- **Step 1.** [Install a supported version of Python on your system](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites) (note: that the system install of Python on macOS is not supported). -- **Step 2.** Install the Jupyter extension for Visual Studio Code. -- **Step 3.** Open or create a Python file and start coding! +- **Step 1.** Install [VS Code Insiders](https://code.visualstudio.com/insiders/) -## Set up your environment +- **Step 2.** Install the [Jupyter Extension](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites) in VS Code Insiders - CHANGE ME - +- **Step 2.1** If you are interested in using Python, we recommend you install the [Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) instead. +- **Step 3.** Make sure you have a kernel specification that corresponds to the language you would like to use installed on Jupyter on your machine. +- **Step 4.** Open or create a notebook file and start coding! -- Select your Python interpreter by clicking on the status bar - - +## Set up your environment -- Configure the debugger through the Debug Activity Bar + - +- To create a new notebook open the command palette (Windows: Ctrl + Shift P, iOS: Command + Shift + P) and select the command `"Jupyter: Create a new blank Jupyter Notebook"` -- Configure tests by running the `Configure Tests` command + - +- Select your kernel by clicking on the kernel picker in the bottom right of the status bar or by envoking the `"Notebook: Select Notebook Kernel"` command. -## Jupyter Notebook quick start + -- Open or create a Jupyter Notebook file (.ipynb) and start coding in our Notebook Editor! +- Change the cell language by clicking the language picker or by envoking the `"Notebook: Change Cell Language"`. - + -For more information you can: +To use the latest version of the extension: -- [Follow our Python tutorial](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites) with step-by-step instructions for building a simple app. -- Check out the [Python documentation on the VS Code site](https://code.visualstudio.com/docs/languages/python) for general information about using the extension. -- Check out the [Jupyter Notebook documentation on the VS Code site](https://code.visualstudio.com/docs/python/jupyter-support) for information about using Jupyter Notebooks in VS Code. +- Set the "jupyter.insidersChannel" setting to "daily" or "weekly" based on how often you would like the extension to check for updates ## Useful commands @@ -42,45 +40,37 @@ Open the Command Palette (Command+Shift+P on macOS and Ctrl+Shift+P on Windows/L | Command | Description | | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Python: Select Interpreter` | Switch between Python interpreters, versions, and environments. | -| `Python: Start REPL` | Start an interactive Python REPL using the selected interpreter in the VS Code terminal. | -| `Python: Run Python File in Terminal` | Runs the active Python file in the VS Code terminal. You can also run a Python file by right-clicking on the file and selecting `Run Python File in Terminal`. | -| `Python: Select Linter` | Switch from Pylint to Flake8 or other supported linters. | -| `Format Document` | Formats code using the provided [formatter](https://code.visualstudio.com/docs/python/editing#_formatting) in the `settings.json` file. | -| `Python: Configure Tests` | Select a test framework and configure it to display the Test Explorer. | +| `Jupyter: Create New Blank Jupyter Notebook`| Create a new blank Jupyter Notebook | +| `Notebook: Select Notebook Kernel` | Select or switch kernels within your notebook| +| `Notebook: Change Cell Language` | Change the language of the cell currently in focus | +| `Jupyter: Export to HTML Jupyter: Export to PDF` | Create a presentation-friendly version of your notebook in HTML or PDF -To see all available Python commands, open the Command Palette and type `Python`. +To see all available Jupyter Notebook commands, open the Command Palette and type `Jupyter` or `Notebook`. ## Feature details Learn more about the rich features of the Jupyter extension: - [IntelliSense](https://code.visualstudio.com/docs/python/editing#_autocomplete-and-intellisense): Edit your code with auto-completion, code navigation, syntax checking and more -- [Linting](https://code.visualstudio.com/docs/python/linting): Get additional code analysis with Pylint, Flake8 and more -- [Code formatting](https://code.visualstudio.com/docs/python/editing#_formatting): Format your code with black, autopep or yapf - -- [Debugging](https://code.visualstudio.com/docs/python/debugging): Debug your Python scripts, web apps, remote or multi-threaded processes -- [Testing](https://code.visualstudio.com/docs/python/unit-testing): Run and debug tests through the Test Explorer with unittest, pytest or nose +- [Debugging](https://code.visualstudio.com/docs/python/debugging): Debug your Jupyter Notebooks with the Interactive Window experience. - [Jupyter Notebooks](https://code.visualstudio.com/docs/python/jupyter-support): Create and edit Jupyter Notebooks, add and run code cells, render plots, visualize variables through the variable explorer, visualize dataframes with the data viewer, and more - [Environments](https://code.visualstudio.com/docs/python/environments): Automatically activate and switch between virtualenv, venv, pipenv, conda and pyenv environments -- [Refactoring](https://code.visualstudio.com/docs/python/editing#_refactoring): Restructure your Python code with variable extraction, method extraction and import sorting - ## Supported locales The extension is available in multiple languages: `de`, `en`, `es`, `fa`, `fr`, `it`, `ja`, `ko-kr`, `nl`, `pl`, `pt-br`, `ru`, `tr`, `zh-cn`, `zh-tw` ## Questions, issues, feature requests, and contributions -- If you have a question about how to accomplish something with the extension, please [ask on Stack Overflow](https://stackoverflow.com/questions/tagged/visual-studio-code+python) -- If you come across a problem with the extension, please [file an issue](https://github.com/microsoft/vscode-jupyter) -- Contributions are always welcome! Please see our [contributing guide](https://github.com/Microsoft/vscode-jupyter/blob/main/CONTRIBUTING.md) for more details -- Any and all feedback is appreciated and welcome! - - If someone has already [filed an issue](https://github.com/Microsoft/vscode-jupyter) that encompasses your feedback, please leave a 👍/👎 reaction on the issue - - Otherwise please file a new issue +- If you have a question about how to accomplish something with the extension, please [ask on Stack Overflow](https://stackoverflow.com/questions/tagged/visual-studio-code+jupyter). +- Any and all feedback is appreciated and welcome! If you come across a problem with the extension, please [file an issue](https://github.com/microsoft/vscode-jupyter). + - If someone has already [filed an issue](https://github.com/Microsoft/vscode-jupyter) that encompasses your feedback, please leave a 👍/👎 reaction on the issue. + +- Contributions are always welcome! Please see our [contributing guide](https://github.com/Microsoft/vscode-jupyter/blob/main/CONTRIBUTING.md) for more details. + - If you're interested in the development of the extension, you can read about our [development process](https://github.com/Microsoft/vscode-jupyter/blob/main/CONTRIBUTING.md#development-process) ## Data and telemetry From 82ce374c11ff36160f111b165655c54147117c88 Mon Sep 17 00:00:00 2001 From: claudiaregio Date: Mon, 9 Nov 2020 17:41:03 -0800 Subject: [PATCH 3/9] Update README.md Co-authored-by: Joyce Er --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e7a2e286e46..00bc48ddafa 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ A [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/) [extens -- Change the cell language by clicking the language picker or by envoking the `"Notebook: Change Cell Language"`. +- Change the cell language by clicking the language picker or by invoking the `"Notebook: Change Cell Language"` command. From 0863881b022e6303081ab74009762baed23930b5 Mon Sep 17 00:00:00 2001 From: claudiaregio Date: Mon, 9 Nov 2020 17:41:38 -0800 Subject: [PATCH 4/9] Update README.md Co-authored-by: Joyce Er --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 00bc48ddafa..98b443dacf6 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ A [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/) [extens -- To create a new notebook open the command palette (Windows: Ctrl + Shift P, iOS: Command + Shift + P) and select the command `"Jupyter: Create a new blank Jupyter Notebook"` +- To create a new notebook open the command palette (Windows: Ctrl + Shift + P, iOS: Command + Shift + P) and select the command `"Jupyter: Create New Blank Jupyter Notebook"` From 154bcdbc9c55386748ae19ff8c4026d2870913b0 Mon Sep 17 00:00:00 2001 From: claudiaregio Date: Mon, 9 Nov 2020 17:41:50 -0800 Subject: [PATCH 5/9] Update README.md Co-authored-by: Joyce Er --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 98b443dacf6..5b42025279d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Jupyter Extension for Visual Studio Code Insiders -A [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/) [extension](https://marketplace.visualstudio.com/VSCode) with support for [Jupyter Notebooks](https://www.python.org/) (working towards supporting all [actively supported kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels)), including features such as IntelliSense, debugging, and more! +A [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/) [extension](https://marketplace.visualstudio.com/VSCode) with support for [Jupyter Notebooks](https://www.jupyter.org/) (working towards supporting all [actively supported kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels)), including features such as IntelliSense, debugging, and more! \*If working in VS Code Stable, please see the [Python Extension ReadMe](https://github.com/microsoft/vscode-python/blob/main/README.md) or the [Python Documentation](https://code.visualstudio.com/docs/python/jupyter-support). From ce6f3c3eb9b4b5ee21ed64b43b7fffc82fe7cc7c Mon Sep 17 00:00:00 2001 From: claudiaregio Date: Mon, 9 Nov 2020 17:50:53 -0800 Subject: [PATCH 6/9] Edit step 3 in setup --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5b42025279d..03003ce4d04 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ A [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/) [extens - **Step 2.** Install the [Jupyter Extension](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites) in VS Code Insiders - CHANGE ME - **Step 2.1** If you are interested in using Python, we recommend you install the [Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) instead. -- **Step 3.** Make sure you have a kernel specification that corresponds to the language you would like to use installed on Jupyter on your machine. +- **Step 3.** If not working with Python, make sure you have a kernel specification that corresponds to the language you would like to use installed on Jupyter on your machine. - **Step 4.** Open or create a notebook file and start coding! ## Set up your environment From 4fbdaeebb7f9a0d45793b13314d113154a5e6185 Mon Sep 17 00:00:00 2001 From: claudiaregio Date: Tue, 10 Nov 2020 16:15:02 -0800 Subject: [PATCH 7/9] Jupyter ReadMe 2 --- README.md | 43 ++++++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 03003ce4d04..70e729e1c02 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,38 @@ -# Jupyter Extension for Visual Studio Code Insiders +# Jupyter Extension for Visual Studio Code -A [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/) [extension](https://marketplace.visualstudio.com/VSCode) with support for [Jupyter Notebooks](https://www.jupyter.org/) (working towards supporting all [actively supported kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels)), including features such as IntelliSense, debugging, and more! +A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marketplace.visualstudio.com/VSCode) - CHANGE ME with support for [Jupyter Notebooks](https://www.jupyter.org/) (working towards supporting all [actively supported kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels)), including features such as IntelliSense, Jupyter Notebooks, and more! -\*If working in VS Code Stable, please see the [Python Extension ReadMe](https://github.com/microsoft/vscode-python/blob/main/README.md) or the [Python Documentation](https://code.visualstudio.com/docs/python/jupyter-support). -## Quick start +## Working with Python + +Whether you are on VS Code Stable or VS Code Insiders, if you would like to work with Python just make sure you're using the latest version of the [Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) to enjoy the joint partnership of the Python and Juypter Extensions! + +Please follow the [Python Extension ReadMe](https://github.com/microsoft/vscode-python/blob/main/README.md) instructions to get started and visit the [Python Documentation](https://code.visualstudio.com/docs/python/jupyter-support) to learn more about how the Python and Jupyter Extension are working together to provide an optimum Python notebooks experience. + +## Working with other Languages + +The Jupyter Extension supports other languages such as Julia and R (as well as Python) in VS Code Insiders with our new Native Notebooks Experience! + +### Quick Start - **Step 1.** Install [VS Code Insiders](https://code.visualstudio.com/insiders/) -- **Step 2.** Install the [Jupyter Extension](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites) in VS Code Insiders - CHANGE ME +- **Step 2** If not working with Python, make sure to have a Jupyter kernelspec that corresponds to the language you would like to use installed on your machine. + +- **Step 3.** Install the [Jupyter Extension](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites) - CHANGE ME -- **Step 2.1** If you are interested in using Python, we recommend you install the [Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) instead. -- **Step 3.** If not working with Python, make sure you have a kernel specification that corresponds to the language you would like to use installed on Jupyter on your machine. - **Step 4.** Open or create a notebook file and start coding! -## Set up your environment +- **Special Note:** The Jupyter Extension in VS Code Insiders will include our Native Notebooks experience! To opt out: + - Open the command palette (Windows: Ctrl + Shift + P, iOS: Command + Shift + P) and select "Preferences: Open Settings (JSON)" + - Add the following code to your JSON settings: + `"jupyter.experiments.optOutFrom": ["NativeNotebookEditor"],` + +To use the latest version of the extension: +- Set the "jupyter.insidersChannel" setting to "daily" or "weekly" based on how often you would like the extension to check for updates + + +## Notebooks Quick Start @@ -22,7 +40,7 @@ A [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/) [extens -- Select your kernel by clicking on the kernel picker in the bottom right of the status bar or by envoking the `"Notebook: Select Notebook Kernel"` command. +- Select your kernel by clicking on the kernel picker in the bottom right of the status bar or by invoking the `"Notebook: Select Notebook Kernel"` command. @@ -30,9 +48,7 @@ A [Visual Studio Code Insiders](https://code.visualstudio.com/insiders/) [extens -To use the latest version of the extension: -- Set the "jupyter.insidersChannel" setting to "daily" or "weekly" based on how often you would like the extension to check for updates ## Useful commands @@ -49,15 +65,12 @@ To see all available Jupyter Notebook commands, open the Command Palette and typ ## Feature details -Learn more about the rich features of the Jupyter extension: +Learn more about the rich features of the Jupyter extension Python: - [IntelliSense](https://code.visualstudio.com/docs/python/editing#_autocomplete-and-intellisense): Edit your code with auto-completion, code navigation, syntax checking and more -- [Debugging](https://code.visualstudio.com/docs/python/debugging): Debug your Jupyter Notebooks with the Interactive Window experience. - - [Jupyter Notebooks](https://code.visualstudio.com/docs/python/jupyter-support): Create and edit Jupyter Notebooks, add and run code cells, render plots, visualize variables through the variable explorer, visualize dataframes with the data viewer, and more -- [Environments](https://code.visualstudio.com/docs/python/environments): Automatically activate and switch between virtualenv, venv, pipenv, conda and pyenv environments ## Supported locales From 10411ed83eec1bcbb561a1b1fade5fda6080cb68 Mon Sep 17 00:00:00 2001 From: claudiaregio Date: Tue, 10 Nov 2020 16:27:21 -0800 Subject: [PATCH 8/9] plz let this be the last jupyter readme update --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 70e729e1c02..778563596e0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Jupyter Extension for Visual Studio Code -A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marketplace.visualstudio.com/VSCode) - CHANGE ME with support for [Jupyter Notebooks](https://www.jupyter.org/) (working towards supporting all [actively supported kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels)), including features such as IntelliSense, Jupyter Notebooks, and more! +A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marketplace.visualstudio.com/VSCode) - CHANGE ME that provides basic notebook support for [language kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels) that are supported in [Jupyter Notebooks](https://jupyter.org/) today. Many language kernels will work with no modification. To enable advanced features, modifications may be needed in the VS Code language extensions. ## Working with Python @@ -34,8 +34,6 @@ To use the latest version of the extension: ## Notebooks Quick Start - - - To create a new notebook open the command palette (Windows: Ctrl + Shift + P, iOS: Command + Shift + P) and select the command `"Jupyter: Create New Blank Jupyter Notebook"` @@ -65,11 +63,12 @@ To see all available Jupyter Notebook commands, open the Command Palette and typ ## Feature details -Learn more about the rich features of the Jupyter extension Python: +Learn more about the rich features of the Jupyter extension: -- [IntelliSense](https://code.visualstudio.com/docs/python/editing#_autocomplete-and-intellisense): Edit your code with auto-completion, code navigation, syntax checking and more +- [IntelliSense](https://code.visualstudio.com/docs/python/editing#_autocomplete-and-intellisense): Edit your code with auto-completion, code navigation, syntax checking and more! + - *May be limited due to kernelspec of choice* -- [Jupyter Notebooks](https://code.visualstudio.com/docs/python/jupyter-support): Create and edit Jupyter Notebooks, add and run code cells, render plots, visualize variables through the variable explorer, visualize dataframes with the data viewer, and more +- [Jupyter Notebooks](https://code.visualstudio.com/docs/python/jupyter-support): Create and edit Jupyter Notebooks, add and run code/markdown cells, render plots, create presentation-friendly versions of your notebook by exporting to HTML or PDF and more! ## Supported locales From 728c642d305bfaab10cffbcc9daea50d40fb3261 Mon Sep 17 00:00:00 2001 From: claudiaregio Date: Wed, 11 Nov 2020 09:42:45 -0800 Subject: [PATCH 9/9] updated jupyter extension marketplace link --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 778563596e0..1493c56cf4a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Jupyter Extension for Visual Studio Code -A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marketplace.visualstudio.com/VSCode) - CHANGE ME that provides basic notebook support for [language kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels) that are supported in [Jupyter Notebooks](https://jupyter.org/) today. Many language kernels will work with no modification. To enable advanced features, modifications may be needed in the VS Code language extensions. +A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter) that provides basic notebook support for [language kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels) that are supported in [Jupyter Notebooks](https://jupyter.org/) today. Many language kernels will work with no modification. To enable advanced features, modifications may be needed in the VS Code language extensions. ## Working with Python @@ -19,7 +19,7 @@ The Jupyter Extension supports other languages such as Julia and R (as well as P - **Step 2** If not working with Python, make sure to have a Jupyter kernelspec that corresponds to the language you would like to use installed on your machine. -- **Step 3.** Install the [Jupyter Extension](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites) - CHANGE ME +- **Step 3.** Install the [Jupyter Extension](https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter) - **Step 4.** Open or create a notebook file and start coding! @@ -83,7 +83,7 @@ The extension is available in multiple languages: `de`, `en`, `es`, `fa`, `fr`, - Contributions are always welcome! Please see our [contributing guide](https://github.com/Microsoft/vscode-jupyter/blob/main/CONTRIBUTING.md) for more details. -- If you're interested in the development of the extension, you can read about our [development process](https://github.com/Microsoft/vscode-jupyter/blob/main/CONTRIBUTING.md#development-process) +- If you're interested in the development of the extension, you can read about our [development process](https://github.com/microsoft/vscode-jupyter/blob/main/CONTRIBUTING.md#development-process) ## Data and telemetry