deephaven-plugin-voice-table

这是一个由deephaven-plugin模板生成的Deephaven Python插件。

此插件通过语音控制界面显示一个表格。按住麦克风按钮，说出一个命令，表格将根据您指定的筛选条件和排序方式更新。

插件结构

src目录包含插件的Python和JavaScript代码。在src目录中，deephaven_plugin_voice_table目录包含Python代码。

此外，test目录包含插件的Python测试。这展示了如何在测试中使用嵌入的Deephaven服务器。建议使用tox运行测试，项目已包含tox.ini文件。

构建插件

要构建插件，您需要安装python，以及Python的build包。可以使用以下命令创建python venv并安装推荐包

cd deephaven_plugin_voice_table
python -m venv .venv
source .venv/bin/activate
pip install --upgrade -r requirements.txt

然后，从顶级目录构建Python插件

python -m build --wheel

构建的wheel文件将位于dist目录。

安装插件

可以使用pip install <wheel file>将插件安装到Deephaven实例中。插件构建后，wheel文件存储在dist目录中。具体做法取决于您如何运行Deephaven。如果使用上面创建的venv，可以使用以下命令创建插件和服务器

pip install deephaven-server
pip install dist/deephaven_plugin_voice_table-0.0.1.dev0-py3-none-any.whl
deephaven server

有关更多信息，请参阅插件文档。

使用插件

Deephaven服务器运行后，插件应可供使用。

以下是一个基本示例，运行以下代码：

from deephaven import new_table
from deephaven.column import string_col, int_col
from deephaven_plugin_voice_table import ui_voice_table

_basic_table = new_table(
    [
        string_col("First", ["John", "Jane", "John", "Mike", "Jane", "Bob"]),
        string_col("Last", ["Doe", "Smith", "Cruise", "Smith", "Doe", "Smith"]),
        int_col("Id", [1, 2, 3, 4, 5, 6])
    ]
)

vc_basic_table = ui_voice_table(_basic_table)

应该会出现一个带有表格和麦克风的面板。点击并按住麦克风，说出一个命令，然后释放麦克风来应用该命令。以下是一些你可以说的示例命令

• 过滤列：“按”，例如“按John过滤第一列”
• 排序列：“按<升/降>排序”，例如“按第一列降序排序”
• 你可以使用“和”来分隔多个命令，例如“按第一列John过滤和按最后一列降序排序”

对于更复杂的示例，安装 deephaven-plugin-plotly-express 插件以获取一些额外的数据集，然后运行以下

from deephaven_plugin_voice_table import ui_voice_table
import deephaven.plot.express as dx

_stocks = dx.data.stocks()

vc_stocks = ui_voice_table(_stocks)

说出类似“按sym过滤CAT和按exchange过滤PETX以及按size降序排序”的命令以查看表格更新：

分发插件

要分发插件，你可以将轮文件上传到包仓库，例如 PyPI。可以在 setup.cfg 文件中更新插件的版本。

有一个单独的PyPI实例用于测试目的。首先在 TestPyPI 上创建一个账户。然后，从 账户管理 获取API令牌，将“范围”设置为“整个账户”。

要将文件上传到测试实例，请使用以下命令

python -m pip install --upgrade twine
python -m twine upload --repository testpypi dist/*

现在，你可以从测试实例安装插件。需要额外的索引来查找依赖项

pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.ac.cn/simple/ deephaven-plugin-voice-table

对于生产版本，请在 PyPI 上创建一个账户。然后，从 账户管理 获取API令牌，将“范围”设置为“整个账户”。

要将文件上传到生产实例，请使用以下命令。注意，默认情况下 --repository 是生产实例，因此可以省略

python -m pip install --upgrade twine
python -m twine upload dist/*

现在，你可以从生产实例安装插件

pip install deephaven-plugin-voice-table

有关更多信息，请参阅 Python 打包文档