vscode-colab 0.1.3

A library to set up a VS Code server in Google Colab.

vscode-colab: Connect VS Code to Google Colab and Kaggle Runtimes

vscode-colab is a Python library that enables you to connect your Google Colab or Kaggle notebooks to your local Visual Studio Code (VS Code) editor using VS Code Remote Tunnels. This integration allows you to leverage the full capabilities of VS Code while utilizing the computational resources of cloud-based notebooks.

🚀 Features

• Seamless connection between Colab/Kaggle notebooks and local VS Code editor.
• Utilizes official VS Code Remote Tunnels for secure and efficient connectivity.
• Minimal setup with intuitive login() and connect() functions.
• Interactive UI elements within notebooks for enhanced user experience.

🧰 Installation

Install the package via pip:

pip install vscode-colab

📖 Usage

1. Import the Library

In your Colab or Kaggle notebook, import the vscode_colab module:

import vscode_colab

2. Authenticate with VS Code

Run the login() function to authenticate your session:

vscode_colab.login()

This will display a code and a URL. Click the URL, enter the code, and sign in with your GitHub or Microsoft account to authorize the connection.

3. Establish the Tunnel

After successful authentication, initiate the tunnel:

vscode_colab.connect()

This will start the VS Code tunnel, allowing you to connect your local VS Code editor to the Colab/Kaggle environment.

4. Connect via VS Code

In your local VS Code editor:

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).
2. Select Remote Tunnels: Connect to Tunnel....
3. Choose the tunnel corresponding to your notebook session.

You are now connected to your Colab/Kaggle environment through VS Code!

⚠️ Notes

• The connect() function will block the notebook cell execution as it maintains the tunnel connection. To terminate the tunnel, you can:
  • Interrupt the cell execution.
  • Close the notebook tab.
  • Shut down the notebook runtime.
• Ensure that your local VS Code editor has the Remote Tunnels extension installed.

🧪 Testing

To run the test suite:

git clone https://github.com/EssenceSentry/vscode-colab.git
cd vscode-colab
pip install -r requirements-dev.txt
pytest

🛠️ Development

The project uses setup.cfg for configuration and requirements-dev.txt for development dependencies. Contributions are welcome!

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙏 Acknowledgments

Special thanks to the developers of VS Code Remote Tunnels for enabling seamless remote development experiences.