跳转到主要内容

JupyterLab扩展。

项目描述

jupyterlab_twitch

Github Actions Status

一个用于显示Twitch内嵌内容的JupyterLab扩展。它提供了可以通过代码显示和修改的Twitch小部件,以及一个独立的Twitch播放器。

项目的目标是构建一种方法,使学生能够在Jupyterlab中观看现场编码会话并与讲师互动。目前,它允许嵌入聊天和视频,但未来的开发将包括使用 twitch-js 与聊天更深入的集成。

需求

  • JupyterLab >= 2.0

安装

jupyter labextension install @data-exp-lab/jupyterlab-twitch

使用方法

您可以使用命令面板中的“Twitch”选项,这将提示您输入频道,或者您可以导入并使用Twitch小部件。使用Twitch小部件是大多数情况的首选,但它也相对较难移动。

import jupyterlab_twitch
player = jupyterlab_twitch.TwitchPlayerModel()
player.channel = "mst3k"
player.volume = 0.9
display(player)

TwitchPlayerModel 上公开的属性只有几个,并且随着聊天和其他功能的添加,它可能还会更改名称。目前,您可以更改频道、音量,并静音或取消静音。您可以为Twitch流创建新的输出并将它拖动,也可以同时使用多个。

这使用的是IFrame嵌入库,因此可能不在非localhost域名上工作。

基于小部件的查看器样式仍然有点笨拙,将在后续版本中改进。

贡献

安装

jlpm 命令是 JupyterLab 的固定版本的 yarn,它与 JupyterLab 一起安装。您可以使用 yarnnpm 替代下面的 jlpm

# Clone the repo to your local environment
# Move to jupyterlab_twitch directory

# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

您可以监视源目录,并在监视模式下运行 JupyterLab,以监视扩展源的变化并自动重新构建扩展和应用程序。

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

卸载

jupyter labextension uninstall @data-exp-lab/jupyterlab-twitch

项目详情


下载文件

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

源分发

jupyterlab_twitch-0.2.0.tar.gz (158.0 kB 查看哈希值)

上传时间

构建分发

jupyterlab_twitch-0.2.0-py3-none-any.whl (161.0 kB 查看哈希值)

上传时间 Python 3

由以下组织支持