donjayamanne / vscodejupyter

Jupyter for Visual Studio Code

Deprecated

This extension is no longer being maintained and all of its functionality has been (or will be) placed into the Microsoft Python extension.

Please download the Microsoft Python Extension instead.

Feel free to submit new issues or feature requests on the Microsoft Python Extension.

Jupyter

An extension with rich support for Jupyter

Quick Start

• Install the extension
• When using Python, install the Microsoft Python extension as well.
• Install Jupyter
  • You're ready to use it.

Sample Python usage

• Create a Python file with the following text

#%%
import matplotlib.pyplot as plt
import matplotlib as mpl
import numpy as np

x = np.linspace(0, 20, 100)
plt.plot(x, np.sin(x))
plt.show() 

• Click on the code lens Run Cell

Run Cell Hot key as in Chrome

• If you want to run cell with Ctrl+Enter, add those code in keybindings.json.

{ "key": "ctrl+enter",      "command": "jupyter.execCurrentCell",
                                  "when": "editorTextFocus"
}

Connect to Remote Jupyter kernel on Server / Docker

Try this to connect to a remote Jupyter kernel running on a server, or inside Docker container:

1. Make sure Jupyter, Notebook, and jupyter_kernel_gateway packages are installed. They are all included by default in Anaconda installation, but if you are using PIP you may need to install them manually.
2. Run following commands on Linux: (Windows users will need to adapt these commands for their env)

# Generate config file for KernelGateway
jupyter kernelgateway --KernelGatewayApp.generate_config=True

# Generate config for Jupyter Notebook
jupyter notebook --generate-config --allow-root

# Append appropriate values to both config files
echo -e "c.JupyterWebsocketPersonality.list_kernels = True" >> ~/.jupyter/jupyter_kernel_gateway_config.py
echo -e "c.NotebookApp.allow_root = True" >> ~/.jupyter/jupyter_notebook_config.py

1. Start a remote Jupyter Notebook or headless KernelGateway
2. Find the token in the output of the Jupyter server logs: http://jupyter-notebook.readthedocs.io/en/latest/security.html

Then in VS Code:

1. ctrl+shift+p
2. Jupyter: Enter the url of local/remote Jupyter Notebook
3. Select existing kernels from the drop-down list, or start a new kernel
4. Select language for the kernel from drop-down list: e.g., "Python 3"

Documentation

For further information and details continue through to the documentation.

Issues, Feature Requests and Contributions

• Contributions are always welcome. Fork it, modify it and create a pull request.
• Any and all feedback is appreciated and welcome.

Roadmap

Version 1.1.3 (5 May 2017)

• Notebook not detected #46

Version 1.1.2 (24 April 2017)

• Fix high CPU usage #40

Version 1.1.1 (13 April 2017)

• Bug fix (extension fails to load)
• Increase timeout waiting for Jupyter Notebook to start

Version 1.1.0 (12 April 2017)

• Preliminary support for older versions of Jupyter Notebook (< 4.2.0)

Source

GitHub

License

MIT