跳转到主要内容

uData内容推荐桥接器

项目描述

udata-recommendations

此插件作为uData和推荐系统之间的桥接器。

在我们的案例中(data.gouv.fr),它是一组位于这里的脚本 https://github.com/etalab/piwik-covisits

推荐存储在数据集中。推荐可以来自各种来源,并按提供的分数(从1到100)降序存储。顶部推荐显示在数据集页面底部。

兼容性

udata-recommendations 需要 Python 3.7+ 和 uData

安装

安装 uData

保持在同一虚拟环境中(对于Python)。

安装 udata-recommendations

pip install udata-recommendations

修改 udata 的本地配置文件(通常为 udata.cfg),如下所示

PLUGINS = ['recommendations']
RECOMMENDATIONS_SOURCES = {
    'source-name': 'https://path/to/recommendations.json',
    'other-source': 'https://path/to/other/recommendations.json',
}
RECOMMENDATIONS_NB_RECOMMENDATIONS = 4
  • RECOMMENDATIONS_SOURCES:推荐源及其URL的键值字典。默认{}
  • RECOMMENDATIONS_NB_RECOMMENDATIONS:在数据集页面上显示的最大推荐数。默认4

用法

添加推荐

您可以将获取和存储推荐作为一个任务,使用在 RECOMMENDATIONS_SOURCES 中配置的内容,并在需要时按计划执行。默认情况下,在导入新的推荐之前会清理之前的推荐,但您有控制权。

udata job run recommendations-add
# Don't clean each source before importing new recommendations
udata job run recommendations-add should_clean=false

删除推荐

要清理所有推荐,您可以运行以下任务。

udata job run recommendations-clean

期望

此插件期望以下格式提供数据集推荐

[
  {
    "id": "dataset-id",
    "recommendations": [
      {
        "id": "dataset-slug-1",
        "score": 100
      },
      {
        "id": "5ef1fe80f50446b8f41ba691",
        "score": 1
      }
    ]
  },
  {
    "id": "dataset-id2",
    "recommendations": [
      {
        "id": "5ef1fe80f50446b8f41ba691",
        "score": 50
      }
    ]
  }
]

数据集ID可以是ID或别名。分数应在 1100 之间,包括这两个数。您可以使用JSON模式验证您的JSON。

变更日志

3.1.6 (2024-07-30)

  • 根据 udata 依赖项升级迁移到 Python 3.11 #265
  • 取消固定 jsonschema 依赖项 #266

3.1.5 (2023-11-21)

  • 更新 Matomo 内容跟踪数据属性 #263
  • 升级测试和开发依赖项 #264

3.1.4 (2023-03-07)

3.1.3 (2023-03-02)

  • 新数据集页面推荐 #256

3.1.2 (2022-12-15)

  • 更新数据集并重用推荐以匹配新的 udata-front 布局 207

3.1.1 (2022-09-01)

  • 在 CI 中替换 mongo 旧版图像 #226
  • 在 extras 中存储唯一的推荐 #239

3.1.0 (2021-09-16)

  • 根据重命名更改 udata-gouvfr 依赖项为 udata-front #188

3.0.0 (2021-08-12)

  • 通过更改导入和样式确保与 udata3 的兼容性 #183

2.2.0 (2020-11-30)

  • 添加重用支持 #153

2.1.1 (2020-10-16)

  • 忽略数据集本身的推荐 #147

2.1.0 (2020-08-25)

  • 添加分数到推荐并支持多个推荐来源 #142

2.0.0 (2020-03-11)

  • udata 2.0 / Python 3 支持 #95
  • 支持新的钩子格式 #96

1.0.1 (2018-08-03)

  • 暂时没有

1.0.0 (2018-06-06)

  • 允许数据集使用别名而不是ID #8
  • 初始版本

项目详情


下载文件

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

源代码分发

此版本没有可用的源代码分发文件。请参阅有关生成分发存档的教程。

构建分发

udata_recommendations-3.1.6-py2.py3-none-any.whl (14.8 kB 查看散列值)

上传时间 Python 2 Python 3

支持