Skip to main content

VSCODE integration in jupyter-lab

Project description

jupyter_coder_server

Disclaimer

Many developers are forced to use jupyterlab\jupyterhub during work, without the ability to use VSCODE. Our comrades from coder have done a great job to make it possible to use VSCODE through a browser. My job is left to make these two technologies friends and provide the ability to quickly and conveniently launch both of these applications.

This library works in tandem with the jupyter-server-proxy library, which in turn allows you to create additional servers inside Jupyter.

VSCode button Web Code Server (proxy)
vscode_button vscode_proxy

Install

Just run the installation from pypi and enjoy After installation, be sure to restart the server (if it is running in docker, then restart docker)

pip install jupyter_coder_server

Extra install

By default, this library installs the latest version of code-server on your device in the ~/.local/lib directory

If you do not want automatic installation, you can do it later or disable it altogether.

Disabling automatic installation of code-server

jupyter_coder_server_SKIP_INSTALL=1 pip install jupyter_coder_server

Installing a specific version of code-server

To do this, you need to set env CODE_SERVER_VERSION CODE_SERVER_VERSION - lataset by default Since version search is not controlled by github tags, it is better to look at the api and search for the id of the release.

Installation example tag_name "v4.99.1"

CODE_SERVER_VERSION=211138150 pip install jupyter_coder_server

CLI Commands

usage: jupyter_coder_server [-h] [--version] [--install] [--install-server] [--install-extensions] [--install-settings] [--patch-tornado]

options:
 -h, --help show this help message and exit
 --version show program's version number and exit
 --install Install code-server, extensions ad settings
 --install-server Install code-server
 --install-extensions Install extensions
 --install-settings Install settings
 --patch-tornado Monkey patch tornado.websocket

Requirements

For more details see here

License

Since the code-server project has an MIT license, I also use it in this project.

Citation

@article{jupyter_coder_server,
title = {{jupyter_coder_server}: VSCODE integration in jupyter-lab},
author = {MiXaiLL76},
year = {2024}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter_coder_server-0.0.1.tar.gz (6.6 kB view details)

Uploaded Source

File details

Details for the file jupyter_coder_server-0.0.1.tar.gz.

File metadata

  • Download URL: jupyter_coder_server-0.0.1.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jupyter_coder_server-0.0.1.tar.gz
Algorithm Hash digest
SHA256 63c5e8cbe27d191698cb2bbc340f27444d3b9e7f77e8ece4daddd55e4fd40a35
MD5 d146e1c2c45475b745cdecdf38f961fc
BLAKE2b-256 c6662ffd082dadd7e605c6e4661ba4e7325daef8bb295971f66748a7bc5dd556

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page