jupyter-coder-server


Namejupyter-coder-server JSON
Version 0.0.7 PyPI version JSON
download
home_pagehttps://github.com/MiXaiLL76/jupyter_coder_server
SummaryVSCODE integration in jupyter-lab
upload_time2025-07-09 09:12:09
maintainerNone
docs_urlNone
authorMiXaiLL76
requires_python>=3.8
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # jupyter_coder_server

[![PyPI](https://img.shields.io/pypi/v/jupyter-coder-server)](https://pypi.org/project/jupyter_coder_server)
[![PyPI Downloads](https://img.shields.io/pypi/dm/jupyter-coder-server.svg?label=PyPI%20downloads)](https://pypi.org/project/jupyter_coder_server/)

## Disclaimer

Many developers are forced to use jupyterlab\\jupyterhub during work, without the ability to use VSCODE.
Our comrades from [coder](https://github.com/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](https://github.com/jupyterhub/jupyter-server-proxy) library, which in turn allows you to create additional servers inside Jupyter.

| VSCode button                                                                                                               | Web Code Server (proxy)                                                                                                   |
| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| ![vscode_button](https://raw.githubusercontent.com/MiXaiLL76/jupyter_coder_server/refs/heads/main/assets/vscode_button.png) | ![vscode_proxy](https://raw.githubusercontent.com/MiXaiLL76/jupyter_coder_server/refs/heads/main/assets/vscode_proxy.png) |

## 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)**

```bash
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

Installing a specific [version of code-server](https://github.com/coder/code-server/releases)

> To do this, you need to set env CODE_SERVER_VERSION
> CODE_SERVER_VERSION - lataset by default
> Since version search is controlled by github tags.

Installation example **tag_name "v4.99.1"**

```bash
CODE_SERVER_VERSION=v4.99.1 jupyter_coder_server --install
```

### CLI Commands

```bash
usage: jupyter_coder_server [-h] [--version] [--install] [--install-server] [--install-extensions] [--install-settings] [--install-filebrowser] [--patch-tornado] [--remove] [--remove-server] [--remove-filebrowser]

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --install             Install coder-server, extensions, settings and Web File Browser
  --install-server      Install coder-server
  --install-extensions  Install extensions
  --install-settings    Install settings
  --install-filebrowser
                        Install Web File Browser
  --patch-tornado       Monkey patch tornado.websocket
  --remove              Remove coder-server and Web File Browser
  --remove-server       Remove coder-server
  --remove-filebrowser  Remove Web File Browser
```

## Requirements

1. Linux amd64
2. Installed CURL

For more details [see here](https://github.com/coder/code-server?tab=readme-ov-file#requirements)

## License

Since the [code-server](https://github.com/coder/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}
}
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/MiXaiLL76/jupyter_coder_server",
    "name": "jupyter-coder-server",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "MiXaiLL76",
    "author_email": "mike.milos@yandex.ru",
    "download_url": "https://files.pythonhosted.org/packages/46/43/238cd9a9ab6b538625ebaf7d0737d2aad90a55d734492c343bdb9c46df2b/jupyter_coder_server-0.0.7.tar.gz",
    "platform": null,
    "description": "# jupyter_coder_server\n\n[![PyPI](https://img.shields.io/pypi/v/jupyter-coder-server)](https://pypi.org/project/jupyter_coder_server)\n[![PyPI Downloads](https://img.shields.io/pypi/dm/jupyter-coder-server.svg?label=PyPI%20downloads)](https://pypi.org/project/jupyter_coder_server/)\n\n## Disclaimer\n\nMany developers are forced to use jupyterlab\\\\jupyterhub during work, without the ability to use VSCODE.\nOur comrades from [coder](https://github.com/coder) have done a great job to make it possible to use VSCODE through a browser.\nMy job is left to make these two technologies friends and provide the ability to quickly and conveniently launch both of these applications.\n\nThis library works in tandem with the [jupyter-server-proxy](https://github.com/jupyterhub/jupyter-server-proxy) library, which in turn allows you to create additional servers inside Jupyter.\n\n| VSCode button                                                                                                               | Web Code Server (proxy)                                                                                                   |\n| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |\n| ![vscode_button](https://raw.githubusercontent.com/MiXaiLL76/jupyter_coder_server/refs/heads/main/assets/vscode_button.png) | ![vscode_proxy](https://raw.githubusercontent.com/MiXaiLL76/jupyter_coder_server/refs/heads/main/assets/vscode_proxy.png) |\n\n## Install\n\nJust run the installation from pypi and enjoy\n**After installation, be sure to restart the server (if it is running in docker, then restart docker)**\n\n```bash\npip install jupyter_coder_server\n```\n\n### Extra install\n\nBy default, this library installs the latest version of code-server on your device in the **~/.local/lib** directory\n\nInstalling a specific [version of code-server](https://github.com/coder/code-server/releases)\n\n> To do this, you need to set env CODE_SERVER_VERSION\n> CODE_SERVER_VERSION - lataset by default\n> Since version search is controlled by github tags.\n\nInstallation example **tag_name \"v4.99.1\"**\n\n```bash\nCODE_SERVER_VERSION=v4.99.1 jupyter_coder_server --install\n```\n\n### CLI Commands\n\n```bash\nusage: jupyter_coder_server [-h] [--version] [--install] [--install-server] [--install-extensions] [--install-settings] [--install-filebrowser] [--patch-tornado] [--remove] [--remove-server] [--remove-filebrowser]\n\noptions:\n  -h, --help            show this help message and exit\n  --version             show program's version number and exit\n  --install             Install coder-server, extensions, settings and Web File Browser\n  --install-server      Install coder-server\n  --install-extensions  Install extensions\n  --install-settings    Install settings\n  --install-filebrowser\n                        Install Web File Browser\n  --patch-tornado       Monkey patch tornado.websocket\n  --remove              Remove coder-server and Web File Browser\n  --remove-server       Remove coder-server\n  --remove-filebrowser  Remove Web File Browser\n```\n\n## Requirements\n\n1. Linux amd64\n2. Installed CURL\n\nFor more details [see here](https://github.com/coder/code-server?tab=readme-ov-file#requirements)\n\n## License\n\nSince the [code-server](https://github.com/coder/code-server) project has an MIT license, I also use it in this project.\n\n## Citation\n\n```\n@article{jupyter_coder_server,\ntitle = {{jupyter_coder_server}: VSCODE integration in jupyter-lab},\nauthor = {MiXaiLL76},\nyear = {2024}\n}\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "VSCODE integration in jupyter-lab",
    "version": "0.0.7",
    "project_urls": {
        "Homepage": "https://github.com/MiXaiLL76/jupyter_coder_server"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4643238cd9a9ab6b538625ebaf7d0737d2aad90a55d734492c343bdb9c46df2b",
                "md5": "9a7cbf64036fb2b7e226273f0ce23953",
                "sha256": "af913839a15c5f720565e246be47e9292c2126efefc506c4f0d05ed06c4b20df"
            },
            "downloads": -1,
            "filename": "jupyter_coder_server-0.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "9a7cbf64036fb2b7e226273f0ce23953",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 14575,
            "upload_time": "2025-07-09T09:12:09",
            "upload_time_iso_8601": "2025-07-09T09:12:09.956902Z",
            "url": "https://files.pythonhosted.org/packages/46/43/238cd9a9ab6b538625ebaf7d0737d2aad90a55d734492c343bdb9c46df2b/jupyter_coder_server-0.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-09 09:12:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "MiXaiLL76",
    "github_project": "jupyter_coder_server",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "jupyter-coder-server"
}
        
Elapsed time: 1.86834s