# jupyter-openvscodeserver-proxy
Integrate [OpenVSCode-Server](https://github.com/gitpod-io/openvscode-server) in your Jupyter environment for an fast, feature-rich and easy to use remote desktop in the browser.
--------------------------------
## Requirements
- Python 3.6+
- Jupyter Notebook 6.0+
- JupyterLab >= 3.x
- jupyter-server-proxy >= 3.2.3
- OpenVSCode-server >= 1.97.0
## Configuration
This package executes the `openvscode-server` command.
It tries to find the `openvscode-server` executable checking the following:
- 1. environment variable $OPENVSCODESERVER_BIN
- 2. `<dir-of-__init__.py>/bin/openvscode-server`
- 3. `which openvscode-server` (searching standard $PATH)
- 4. special locations:
- `/opt/openvscode-server/bin/openvscode-server`
The jupyter-openvscodeserver-proxy can be configures via the following environment variables
- `JUPYTER_OPENVSCODE_PROXY_TIMEOUT` = `<int>` , default = 60
- Specifies how long jupyter-openvscodeserver-proxy shall wait for the OpenVSCode-Server to startup until it gives up.
- `JUPYTER_OPENVSCODE_PROXY_USE_SOCKET` = `'FALSE' | 'TRUE'` , default = `FALSE`
- Use unix sockets for highest security standards.
- `JUPYTER_OPENVSCODE_PROXY_DEBUG` = `'FALSE' | 'TRUE'` , default = `FALSE`
- Enable to print some log messages to stderr.
- `JUPYTER_OPENVSCODE_PROXY_SERVER_DATA_DIR` = `<path>`
- Specifies the directory that server data is kept in. If not set the default is used.
- `JUPYTER_OPENVSCODE_PROXY_USER_DATA_DIR` = `<path>`
- Specifies the directory that user data is kept in. If not set the default is used.
- `JUPYTER_OPENVSCODE_PROXY_EXTENSIONS_DIR` = `<path>`
- Specifies the directory that extensions are kept in. If not set the default is used.
## Install
#### Create and Activate Environment
```
virtualenv -p python3 venv
source venv/bin/activate
```
#### Install jupyter-openvscodeserver-proxy
```
pip install git+https://github.com/FZJ-JSC/jupyter-openvscodeserver-proxy.git
```
#### Enable jupyter-openvscodeserver-proxy extensions
For Jupyter Classic, activate the jupyter-server-proxy extension:
```
jupyter serverextension enable --sys-prefix jupyter_server_proxy
```
For Jupyter Lab, install the @jupyterlab/server-proxy extension:
```
jupyter labextension install @jupyterlab/server-proxy
jupyter lab build
```
#### Start Jupyter Classic or Jupyter Lab
Click on the openvscode-server icon from the Jupyter Lab Launcher or the openvscode-server item from the New dropdown in Jupyter Classic.
Connect to your database as instructed in the Quickstart section.
This package calls `openvscode-server` with a bunch of settings.
## Credits
- [openvscode-server](https://github.com/gitpod-io/openvscode-server)
- [jupyter-server-proxy](https://github.com/jupyterhub/jupyter-server-proxy)
## License
BSD 3-Clause
Raw data
{
"_id": null,
"home_page": "https://github.com/FZJ-JSC/jupyter-openvscodeserver-proxy",
"name": "jupyter-openvscodeserver-proxy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "jupyter, openvscode-server, jupyterhub, jupyter-server-proxy",
"author": "Jens Henrik Goebbert",
"author_email": "j.goebbert@fz-juelich.de",
"download_url": "https://files.pythonhosted.org/packages/3c/97/e159b058be2c5f61105f095a4aba7ecd1d285710ab9fc98b67ef60db30b7/jupyter_openvscodeserver_proxy-0.9.2.tar.gz",
"platform": null,
"description": "\n\n# jupyter-openvscodeserver-proxy\nIntegrate [OpenVSCode-Server](https://github.com/gitpod-io/openvscode-server) in your Jupyter environment for an fast, feature-rich and easy to use remote desktop in the browser.\n\n--------------------------------\n\n\n\n## Requirements\n- Python 3.6+\n- Jupyter Notebook 6.0+\n- JupyterLab >= 3.x\n- jupyter-server-proxy >= 3.2.3\n- OpenVSCode-server >= 1.97.0\n\n## Configuration\nThis package executes the `openvscode-server` command. \nIt tries to find the `openvscode-server` executable checking the following: \n- 1. environment variable $OPENVSCODESERVER_BIN\n- 2. `<dir-of-__init__.py>/bin/openvscode-server`\n- 3. `which openvscode-server` (searching standard $PATH)\n- 4. special locations:\n - `/opt/openvscode-server/bin/openvscode-server`\n\nThe jupyter-openvscodeserver-proxy can be configures via the following environment variables\n\n- `JUPYTER_OPENVSCODE_PROXY_TIMEOUT` = `<int>` , default = 60\n - Specifies how long jupyter-openvscodeserver-proxy shall wait for the OpenVSCode-Server to startup until it gives up.\n- `JUPYTER_OPENVSCODE_PROXY_USE_SOCKET` = `'FALSE' | 'TRUE'` , default = `FALSE`\n - Use unix sockets for highest security standards.\n- `JUPYTER_OPENVSCODE_PROXY_DEBUG` = `'FALSE' | 'TRUE'` , default = `FALSE`\n - Enable to print some log messages to stderr.\n\n- `JUPYTER_OPENVSCODE_PROXY_SERVER_DATA_DIR` = `<path>`\n - Specifies the directory that server data is kept in. If not set the default is used.\n- `JUPYTER_OPENVSCODE_PROXY_USER_DATA_DIR` = `<path>`\n - Specifies the directory that user data is kept in. If not set the default is used.\n- `JUPYTER_OPENVSCODE_PROXY_EXTENSIONS_DIR` = `<path>`\n - Specifies the directory that extensions are kept in. If not set the default is used.\n\n## Install \n\n#### Create and Activate Environment\n```\nvirtualenv -p python3 venv\nsource venv/bin/activate\n```\n\n#### Install jupyter-openvscodeserver-proxy\n```\npip install git+https://github.com/FZJ-JSC/jupyter-openvscodeserver-proxy.git\n```\n\n#### Enable jupyter-openvscodeserver-proxy extensions\nFor Jupyter Classic, activate the jupyter-server-proxy extension:\n```\njupyter serverextension enable --sys-prefix jupyter_server_proxy\n```\n\nFor Jupyter Lab, install the @jupyterlab/server-proxy extension:\n```\njupyter labextension install @jupyterlab/server-proxy\njupyter lab build\n```\n\n#### Start Jupyter Classic or Jupyter Lab\nClick on the openvscode-server icon from the Jupyter Lab Launcher or the openvscode-server item from the New dropdown in Jupyter Classic. \nConnect to your database as instructed in the Quickstart section.\n\nThis package calls `openvscode-server` with a bunch of settings. \n\n## Credits\n- [openvscode-server](https://github.com/gitpod-io/openvscode-server) \n- [jupyter-server-proxy](https://github.com/jupyterhub/jupyter-server-proxy)\n\n## License\nBSD 3-Clause\n",
"bugtrack_url": null,
"license": null,
"summary": "OpenVSCode-Server for JupyterLab",
"version": "0.9.2",
"project_urls": {
"Download": "https://github.com/FZJ-JSC/jupyter-openvscodeserver-proxy/archive/refs/tags/v0.9.2.tar.gz",
"Homepage": "https://github.com/FZJ-JSC/jupyter-openvscodeserver-proxy"
},
"split_keywords": [
"jupyter",
" openvscode-server",
" jupyterhub",
" jupyter-server-proxy"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "944bd8c4bde8031b692d4300da242b45876e5fe7119c92898f748bfef592611f",
"md5": "60ab05fa3da97e84ee6e39e33088ac24",
"sha256": "36e6a6792ca1ea78fc58d76e7809f04181664e0e3332fea0ad6236e64f1cc4d7"
},
"downloads": -1,
"filename": "jupyter_openvscodeserver_proxy-0.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "60ab05fa3da97e84ee6e39e33088ac24",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8980,
"upload_time": "2025-03-01T20:21:30",
"upload_time_iso_8601": "2025-03-01T20:21:30.115295Z",
"url": "https://files.pythonhosted.org/packages/94/4b/d8c4bde8031b692d4300da242b45876e5fe7119c92898f748bfef592611f/jupyter_openvscodeserver_proxy-0.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3c97e159b058be2c5f61105f095a4aba7ecd1d285710ab9fc98b67ef60db30b7",
"md5": "75718d2837380eab100edc7c2704e469",
"sha256": "5aa432f15bb70138dcbe75329dd3e50aff89364f6485dc26e83848fee13dfd59"
},
"downloads": -1,
"filename": "jupyter_openvscodeserver_proxy-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "75718d2837380eab100edc7c2704e469",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8943,
"upload_time": "2025-03-01T20:21:31",
"upload_time_iso_8601": "2025-03-01T20:21:31.779126Z",
"url": "https://files.pythonhosted.org/packages/3c/97/e159b058be2c5f61105f095a4aba7ecd1d285710ab9fc98b67ef60db30b7/jupyter_openvscodeserver_proxy-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-01 20:21:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FZJ-JSC",
"github_project": "jupyter-openvscodeserver-proxy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "jupyter-server-proxy",
"specs": [
[
">=",
"3.2.3"
]
]
}
],
"lcname": "jupyter-openvscodeserver-proxy"
}
JSON
