一个用于在表格数据上添加注释的 Datasette 插件。

阅读 使用 datasette-comments 注释和探索你的数据 了解该项目的背景信息。

datasette-comments 需要 Datasette 的最新 1.0 alpha 版本才能运行。

pip install datasette==1.0a7

之后，在与 Datasette 相同的环境中安装此插件。

datasette install datasette-comments

datasette-comments 将评论存储在 Datasette 的内部数据库 中。因此，为了在多次重启后保留评论，请在启动时提供数据库路径，如下所示

datasette --internal internal.db my_data.db

当在 my_data.db 中的行上发表评论时，评论本身会单独存储在 internal.db 中。

需要 datasette-comments-access 权限才能查看和添加评论。要为特定用户授予权限，请按照以下方式设置你的 metadata.yaml：

permissions:
  datasette-comments-access:
    id: ["simonw", "asg017"]

为了提供参与者（actor）和 ID，你需要设置一个单独的 Datasette 身份验证插件。考虑使用 datasette-auth-passwords 进行简单的用户名/密码设置。

此插件提供了以下插件钩子，可用于自定义其行为：

此钩子应返回一个字典列表，每个字典代表一个应可供插件使用的用户。每个字典应包含以下键：

• id：用户的唯一 ID，与参与者（actor）ID 相同。
• username：用于搜索和 @ 提及的唯一字符串。
• name：用户的自然姓名字符串。
• profile_photo_url：用户头像的可选 URL。
• email：用于 Gravatar 头像的可选电子邮件，如果启用。

插件钩子可以返回一个列表，或者返回一个可等待的函数，该函数返回一个列表。

要在本地设置此插件，首先签出代码。然后创建一个新的虚拟环境：

cd datasette-comments
python3 -m venv venv
source venv/bin/activate

现在安装依赖项和测试依赖项：

pip install -e '.[test]'

以及 JavaScript 依赖项（运行 JavaScript 构建所需）：

npm install

运行测试：

pytest

在修改 .ts 或 .tsx 文件后重建最小化的 JavaScript：

just js