星海智算开发文档
应用开发开发教程

安装 Python SDK

安装 Python SDK:沿用平台当前公开 SDK 合同,区分本地模拟、联网调试与正式运行。

使用 Python 标准虚拟环境和 pip,不要求另装包管理器。项目需使用 Python 3.12 或更高版本。 应用开发者工作台生成的凭据只在当前终端或 CI secret 中使用。优先直接复制应用开发者工作台给出的完整安装命令;下面的通用写法要求把版本变量替换成页面显示值:

python3.12 -m venv .venv
. .venv/bin/activate
export JUSP_PACKAGE_TOKEN='<短期安装凭据>'
export JUSP_PLATFORM_SDK_VERSION='<应用开发者工作台显示的当前稳定版本>'
PIP_INDEX_URL="https://__token__:${JUSP_PACKAGE_TOKEN}@app-api.jusuanhub.com:10443/api/v1/appstore/sdk/python/simple/" \
PIP_EXTRA_INDEX_URL="https://pypi.org/simple" \
python -m pip install "jusp-platform-sdk==${JUSP_PLATFORM_SDK_VERSION}"
unset JUSP_PACKAGE_TOKEN JUSP_PLATFORM_SDK_VERSION

项目依赖

pyproject.toml 只声明包,不保存平台地址或凭据。项目锁文件应记录应用开发者工作台当前显示、且已经过本应用验证的精确版本:

dependencies = ["jusp-platform-sdk"]

安装时继续使用短期环境变量,不把令牌写入 pyproject.toml、锁文件或仓库。升级 SDK 必须显式重新解析并提交锁文件,平台发布新包不会自动改变已部署应用:

export JUSP_PACKAGE_TOKEN='<短期安装凭据>'
PIP_INDEX_URL="https://__token__:${JUSP_PACKAGE_TOKEN}@app-api.jusuanhub.com:10443/api/v1/appstore/sdk/python/simple/" \
PIP_EXTRA_INDEX_URL="https://pypi.org/simple" \
python -m pip install .
unset JUSP_PACKAGE_TOKEN

命令只在进程环境中组装认证 URL;不要把展开后的 URL 打印到日志,也不要写入配置文件。

Docker BuildKit

RUN --mount=type=secret,id=jusp_sdk_index_token,target=/run/secrets/jusp_sdk_index_token,required=true \
    export JUSP_PACKAGE_TOKEN="$(cat /run/secrets/jusp_sdk_index_token)" \
    && PIP_INDEX_URL="https://__token__:${JUSP_PACKAGE_TOKEN}@app-api.jusuanhub.com:10443/api/v1/appstore/sdk/python/simple/" \
       PIP_EXTRA_INDEX_URL="https://pypi.org/simple" \
       python -m pip install --no-cache-dir . \
    && unset JUSP_PACKAGE_TOKEN

构建机直接访问平台 HTTPS 索引。不要使用 Git SSH 安装,也不要把 wheel 和下载凭据作为普通文件放进镜像构建上下文。


返回应用开发 · 下一步:运行本地模拟

本页目录