vscode-offline 0.1.0__py3-none-any.whl

vscode_offline/__init__.py

@@ -0,0 +1,3 @@
+from vscode_offline.app import main
+
+__all__ = ("main",)

vscode_offline/app.py

@@ -0,0 +1,104 @@
+from __future__ import annotations
+
+import logging
+from argparse import ArgumentParser, Namespace
+from pathlib import Path
+
+from vscode_offline.download import download_vscode_extensions, download_vscode_server
+from vscode_offline.install import install_vscode_extensions, install_vscode_server
+from vscode_offline.paths import (
+    get_vscode_cli_bin,
+    get_vscode_extensions_config,
+    get_vscode_server_home,
+)
+
+cli_os_mapping = {
+    "linux-x64": "cli-alpine-x64",
+}
+
+
+def download(args: Namespace) -> None:
+    download_vscode_server(
+        args.commit,
+        output=args.installer / f"cli-{args.commit}",
+        target_platform=args.target_platform,
+        cli_os=cli_os_mapping[args.target_platform],
+    )
+    extensions_config = Path(args.extensions_config).expanduser()
+    download_vscode_extensions(
+        extensions_config, args.target_platform, args.installer / "extensions"
+    )
+
+
+def install(args: Namespace) -> None:
+    install_vscode_server(
+        args.commit,
+        installer=args.installer / f"cli-{args.commit}",
+        vscode_cli_bin=get_vscode_cli_bin(args.commit),
+        target_platform=args.target_platform,
+        cli_os=cli_os_mapping[args.target_platform],
+    )
+    vscode_server_home = get_vscode_server_home(args.commit)
+    install_vscode_extensions(
+        Path(vscode_server_home) / "bin/code-server",
+        vsix_dir=args.installer / "extensions",
+    )
+
+
+def make_argparser() -> ArgumentParser:
+    parent_parser = ArgumentParser(add_help=False)
+
+    parent_parser.add_argument(
+        "--commit",
+        type=str,
+        required=True,
+        help="The commit hash of the VSCode server to download, must match the version of the VSCode client.",
+    )
+    parent_parser.add_argument(
+        "--target-platform",
+        type=str,
+        default="linux-x64",
+        help="The target platform for the VSCode server.",
+    )
+    parent_parser.add_argument(
+        "--installer",
+        type=Path,
+        default="./vscode-offline-installer",
+        help="The output directory for downloaded files. Also used as the installer directory.",
+    )
+
+    parser = ArgumentParser()
+    subparsers = parser.add_subparsers(required=True)
+
+    download_parser = subparsers.add_parser(
+        "download",
+        help="Download VSCode server and extensions",
+        parents=[parent_parser],
+    )
+    download_parser.set_defaults(func=download)
+    download_parser.add_argument(
+        "--extensions-config",
+        type=Path,
+        default=get_vscode_extensions_config(),
+        help="Path to the extensions configuration file. Will search for extensions to download.",
+    )
+
+    install_parsers = subparsers.add_parser(
+        "install",
+        help="Install VSCode server and extensions",
+        parents=[parent_parser],
+    )
+    install_parsers.set_defaults(func=install)
+
+    return parser
+
+
+def main() -> None:
+    logging.basicConfig(level=logging.INFO)
+    parser = make_argparser()
+    args = parser.parse_args()
+    args.func(args)
+
+
+if __name__ == "__main__":
+    main()

vscode_offline/download.py

@@ -0,0 +1,106 @@
+from __future__ import annotations
+
+import json
+import os
+from gzip import GzipFile
+from urllib.error import HTTPError
+from urllib.request import urlopen
+
+from vscode_offline.loggers import logger
+
+
+def _download_file(url: str, filename: str) -> None:
+    with urlopen(url) as resp:
+        content_encoding = resp.headers.get("Content-Encoding")
+        if content_encoding in {"gzip", "deflate"}:
+            logger.info(f"Content encoding is {content_encoding}, using GzipFile")
+            reader = GzipFile(fileobj=resp)
+        elif not content_encoding:
+            reader = resp
+        else:
+            raise ValueError(f"Unsupported Content-Encoding: {content_encoding}")
+
+        with reader, open(filename, "wb") as fp:
+            while True:
+                chunk = reader.read(1024)
+                if not chunk:
+                    break
+                fp.write(chunk)
+
+
+def download_file(
+    url: str,
+    filename: str,
+) -> None:
+    logger.info(f"Downloading {filename}")
+    tmp_filename = f"{filename}.tmp"
+
+    for i in range(3):
+        try:
+            _download_file(url, tmp_filename)
+            break
+        except Exception as e:
+            if isinstance(e, HTTPError) and e.code == 404:
+                raise
+            logger.info(f"Attempt {i + 1} failed: {e}")
+
+    if os.path.exists(filename):
+        os.remove(filename)
+    os.rename(tmp_filename, filename)
+
+    logger.info(f"Saved to {filename}")
+
+
+def download_extension(
+    publisher: str,
+    name: str,
+    version: str,
+    platform: str | None = None,
+    output: str = ".",
+) -> None:
+    url = f"https://marketplace.visualstudio.com/_apis/public/gallery/publishers/{publisher}/vsextensions/{name}/{version}/vspackage"
+    if platform:
+        url = f"{url}?targetPlatform={platform}"
+    filename = f"{publisher}.{name}-{version}"
+    if platform:
+        filename = f"{filename}@{platform}"
+    filename = f"{filename}.vsix"
+    download_file(url, f"{output}/{filename}")
+
+
+def download_vscode_extensions(
+    extensions_config: os.PathLike[str], target_platform: str, output: str = "."
+) -> None:
+    logger.info(f"Reading extensions config from {extensions_config}")
+    with open(extensions_config) as fp:
+        data = json.loads(fp.read())
+
+    os.makedirs(output, exist_ok=True)
+    for extension in data:
+        identifier = extension["identifier"]
+        publisher, name = identifier["id"].split(".")
+        version = extension["version"]
+        try:
+            download_extension(publisher, name, version, target_platform, output=output)
+        except HTTPError as e:
+            if e.code != 404:
+                raise
+            download_extension(publisher, name, version, output=output)
+        logger.info("============================================")
+
+
+def download_vscode_server(
+    commit: str, output: str, target_platform: str, cli_os: str
+) -> None:
+    os.makedirs(output, exist_ok=True)
+    download_file(
+        f"https://vscode.download.prss.microsoft.com/dbazure/download/stable/{commit}/vscode-server-linux-x64.tar.gz",
+        f"{output}/vscode-server-linux-x64.tar.gz",
+    )
+    logger.info("============================================")
+    cli_os_ = cli_os.replace("-", "_")
+    download_file(
+        f"https://vscode.download.prss.microsoft.com/dbazure/download/stable/{commit}/vscode_{cli_os_}_cli.tar.gz",
+        f"{output}/vscode_{cli_os_}_cli.tar.gz",
+    )
+    logger.info("============================================")

vscode_offline/install.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+import os
+import subprocess
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+from vscode_offline.loggers import logger
+from vscode_offline.paths import get_vscode_server_home
+
+EXCLUDE_EXTENSIONS = {
+    "ms-vscode-remote.remote-ssh",
+    "ms-vscode-remote.remote-ssh-edit",
+    "ms-vscode-remote.remote-wsl",
+    "ms-vscode-remote.remote-containers",
+    "ms-vscode.remote-explorer",
+    "ms-vscode-remote.vscode-remote-extensionpack",
+    "ms-vscode.remote-server",
+}
+
+
+def get_extension_identifier(filename: str) -> str:
+    filename = os.path.splitext(filename)[0]
+    identifier_version = filename.rsplit("@", maxsplit=1)[0]
+    extension_identifier = identifier_version.rsplit("-", maxsplit=1)[0]
+    return extension_identifier
+
+
+def install_vscode_extensions(vscode_bin: os.PathLike[str], vsix_dir: str) -> None:
+    for vsix_file in Path(vsix_dir).glob("*.vsix"):
+        extension_identifier = get_extension_identifier(vsix_file.name)
+        if extension_identifier in EXCLUDE_EXTENSIONS:
+            logger.info(f"Skipping excluded extension {extension_identifier}")
+            continue
+        logger.info(f"Installing {vsix_file}")
+        subprocess.check_call([vscode_bin, "--install-extension", vsix_file, "--force"])
+        logger.info(f"Installed {vsix_file}")
+
+
+def install_vscode_server(
+    commit: str,
+    installer: str,
+    vscode_cli_bin: os.PathLike[str],
+    target_platform: str,
+    cli_os: str,
+) -> None:
+    cli_os_ = cli_os.replace("-", "_")
+
+    vscode_cli_tarball = Path(installer) / f"vscode_{cli_os_}_cli.tar.gz"
+    with TemporaryDirectory() as tmpdir:
+        subprocess.check_call(["tar", "-xzf", vscode_cli_tarball, "-C", tmpdir])
+        tmpfile = Path(tmpdir) / "code"
+        if os.path.exists(vscode_cli_bin):
+            os.remove(vscode_cli_bin)
+        os.makedirs(os.path.dirname(vscode_cli_bin), exist_ok=True)
+        os.rename(tmpfile, vscode_cli_bin)
+    logger.info(f"Extracted vscode_{cli_os_}_cli.tar.gz to {vscode_cli_bin}")
+
+    vscode_server_tarball = Path(installer) / f"vscode-server-{target_platform}.tar.gz"
+    vscode_server_home = get_vscode_server_home(commit)
+    os.makedirs(vscode_server_home, exist_ok=True)
+    subprocess.check_call(
+        [
+            "tar",
+            "-xzf",
+            vscode_server_tarball,
+            "-C",
+            vscode_server_home,
+            "--strip-components=1",
+        ]
+    )
+    logger.info(
+        f"Extracted vscode-server-{target_platform}.tar.gz to {vscode_server_home}"
+    )

vscode_offline/loggers.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from logging import getLogger
+
+logger = getLogger("vscode_offline")

vscode_offline/paths.py

@@ -0,0 +1,25 @@
+from __future__ import annotations
+
+import os
+from pathlib import Path
+
+VSCODE_DATA = Path("~/.vscode").expanduser()
+VSCODE_SERVER_DATA = Path("~/.vscode-server").expanduser()
+
+
+def get_vscode_cli_bin(commit: str) -> os.PathLike[str]:
+    return VSCODE_SERVER_DATA / f"code-{commit}"
+
+
+def get_vscode_server_home(commit: str) -> os.PathLike[str]:
+    return VSCODE_SERVER_DATA / f"cli/servers/Stable-{commit}/server"
+
+
+def get_vscode_extensions_config() -> os.PathLike[str]:
+    p = VSCODE_DATA / "extensions/extensions.json"
+    if p.exists():
+        return p
+    s = VSCODE_SERVER_DATA / "extensions/extensions.json"
+    if s.exists():
+        return s
+    return p  # default to this path

vscode_offline-0.1.0.dist-info/METADATA

@@ -0,0 +1,50 @@
+Metadata-Version: 2.3
+Name: vscode-offline
+Version: 0.1.0
+Summary: Download and install vscode server for offline environments
+Author: Chuck Fan
+Author-email: Chuck Fan <fanck0605@qq.com>
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# vscode-offline
+
+vscode-offline 主要用于在无网环境下安装 VSCode Server，方便使用 *Remote - SSH* 插件进行远程开发。
+
+## 安装
+
+```shell
+pip install -U vscode-offline
+```
+
+## 用法
+
+（1）在联网环境安装好 VSCode 和你需要的插件。
+
+（2）联网环境执行如下命令，将会自动下载当前 VSCode 所有的插件
+
+> `--commit` 为对应 VSCode 的 Commit 号，*帮助* -> *关于* -> *Commit*
+
+```shell
+vscode-offline download \
+    --commit 385651c938df8a906869babee516bffd0ddb9829 \
+    --target-platform linux-x64 \
+    --installer ./vscode-offline-installer
+```
+
+（3）复制 `vscode-offline-installer` 到内网服务器
+
+```shell
+vscode-offline install \
+    --commit 385651c938df8a906869babee516bffd0ddb9829 \
+    --target-platform linux-x64 \
+    --installer ./vscode-offline-installer
+```
+
+## 贡献
+
+欢迎提交 Issue 和 PR 改进本项目。
+
+## 许可证
+
+[MIT License](./LICENSE)

vscode_offline-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+vscode_offline/__init__.py,sha256=dr6Jtj0XT9eQEC4fzNigEYsAIEfCsaom3HDbUsS-2O4,57
+vscode_offline/app.py,sha256=pdr7F7vjDVIupkaZSoqL1ZAWNZPAGyPx52lLtcTUYpo,3052
+vscode_offline/download.py,sha256=thEFFn4XuoHqH0f6cuUcOWWeUQwNhPjKO5d681xIyL4,3478
+vscode_offline/install.py,sha256=D4klu6aKeqp6bSQkWLzFmaTNalvekw5L93Y4FQs-jFA,2554
+vscode_offline/loggers.py,sha256=vX91NMtNo1xfxq5y4BCtm_uhCTKtCODqBJHNvcT7JdQ,104
+vscode_offline/paths.py,sha256=WnOzG6a7PXFurgkVUirHtIyRDnF80PzjKHtdMXSlcbU,693
+vscode_offline-0.1.0.dist-info/WHEEL,sha256=-neZj6nU9KAMg2CnCY6T3w8J53nx1kFGw_9HfoSzM60,79
+vscode_offline-0.1.0.dist-info/entry_points.txt,sha256=zIMeh_ENKKzlt9lDao8icofSI0TeCQxH8eCwxIRI2G8,56
+vscode_offline-0.1.0.dist-info/METADATA,sha256=Zi7Fel9ALNPmqHosPrBhRa0X8y8BAaS-9YkVbhONa08,1198
+vscode_offline-0.1.0.dist-info/RECORD,,

vscode_offline-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.8.22
+Root-Is-Purelib: true
+Tag: py3-none-any

vscode_offline-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+vscode-offline = vscode_offline:main
+