跳转到主要内容

trame的内部客户端

项目描述

Test and Release

trame-client是与trame一起提供的通用单页应用程序。trame-client为客户端(浏览器)提供连接到trame服务器、与服务器同步其状态、调用方法、动态加载组件以及填充服务器提供的动态模板的基础设施。

此包不应单独使用,而应作为trame的依赖项。有关任何特定信息,请参阅trame文档

安装

可以使用pip安装trame-client。

pip install --upgrade trame-client

用法

前往Trame教程,了解如何使用库并开始构建自己的应用程序。

API参考文档提供API级别的文档。

许可证

trame-client 在MIT许可证下提供。有关更多详细信息,请参阅许可证。此许可证的选择是为了与Vue.js使用的许可证相匹配,这对于实现该库至关重要。

社区

Trame | 讨论 | 问题 | 路线图 | 联系我们

https://zenodo.org/badge/410108340.svg

喜欢trame吗?

通过推荐信品牌认可分享您的经验。

运行时配置

Trame客户端是trame的JS核心,可以通过URL参数进行调整。下表列出了我们处理的参数以及它们如何影响客户端。

URL参数

enableSharedArrayBufferServiceWorker

当设置为true时,将加载一个额外的脚本,该脚本将使用service worker启用SharedArrayBuffer

ui

布局名称选择器。当trame应用程序定义了具有不同名称的多个布局时,可以选择应显示哪个布局。

remove

默认情况下,URL将从trame配置参数(sessionURL、sessionManagerURL、secret、application)中清理,但如果还需要删除其他参数(在启动器配置中使用),可以通过添加&remove=param1,param2来实现。

下表利用环境变量,主要用于Jupyter Lab环境和iframe构建器配置。

环境变量

TRAME_JUPYTER_ENDPOINT

由trame-jupyter-extension使用

TRAME_JUPYTER_WWW

由trame-jupyter-extension使用

JUPYTERHUB_SERVICE_PREFIX

用于确定iframe构建器的服务器代理路径

HOSTNAME

当“jupyter-hub-host”用作iframe构建器时,将使用该环境变量查找主机名

TRAME_IFRAME_BUILDER

指定应使用哪个iframe构建器。如果没有提供,我们将尝试进行一些智能检测。

TRAME_IPYWIDGETS_DISABLE

跳过任何iPyWidget iframe包装

开发

构建客户端代码库

cd vue[2,3]-app
npm install
npm run build            # build trame client application
cd -

项目详情


发布历史 发布通知 | RSS源

下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

trame-client-3.3.2.tar.gz (230.2 kB 查看散列值)

上传时间 源代码

构建分发

trame_client-3.3.2-py3-none-any.whl (235.7 kB 查看散列值)

上传时间 Python 3

由以下支持