datasette-remote-metadata

定期从远程URL刷新Datasette元数据

安装

在Datasette相同的环境中安装此插件。

$ datasette install datasette-remote-metadata

使用

将以下内容添加到您的metadata.json

{
    "plugins": {
        "datasette-remote-metadata": {
            "url": "https://example.com/remote-metadata.yml"
        }
    }
}

插件将在启动时从该URL获取指定的元数据，并将其与任何现有元数据合并。您可以使用指向JSON文件或YAML文件的URL。

它将定期刷新该元数据 - 默认情况下每30秒刷新一次，除非您在插件配置中指定了不同的"ttl"值。

配置

可用的配置选项如下

• "url" - 获取远程元数据的URL。可以链接到JSON文件或YAML文件。
• "ttl" - 以秒为单位的整数值：脚本应多久检查一次新的元数据。默认为30秒。
• "headers" - 要发送的附加请求头字典。
• "cachebust" - 如果为true，将在远程元数据的查询字符串中添加随机的?0.29508值，以清除任何中间缓存。

此示例metadata.json配置每10秒刷新一次，使用缓存清除，并在请求中发送Authorization: Bearer xyz头。

{
    "plugins": {
        "datasette-remote-metadata": {
            "url": "https://example.com/remote-metadata.yml",
            "ttl": 10,
            "cachebust": true,
            "headers": {
                "Authorization": "Bearer xyz"
            }
        }
    }
}

如果您正在使用metadata.yaml进行配置的示例

plugins:
  datasette-remote-metadata:
    url: https://example.com/remote-metadata.yml
    ttl: 10
    cachebust: true
    headers:
      Authorization: Bearer xyz

开发

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

cd datasette-remote-metadata
python3 -mvenv venv
source venv/bin/activate

或者如果您正在使用pipenv

pipenv shell

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

pip install -e '.[test]'

要运行测试

pytest