pdok/linkage-checker

linkage-checker

镜像概述和主要用途

linkage-checker是一个Python包装器，用于运行INSPIRE链接检查器并聚合检查结果。本镜像为概念验证版本，已测试兼容INSPIRE链接检查器1.4.0版本。

核心功能和特性

• 包装INSPIRE链接检查器，实现结果聚合
• 支持结果输出到JSON文件
• 提供调试模式，仅运行前三条NGR记录测试
• 支持本地缓存NGR记录（用于调试）
• 可生成浏览器截图（用于调试）
• 支持日志级别控制（CRITICAL、ERROR、WARNING、INFO、DEBUG）

使用场景和适用范围

适用于需要对INSPIRE相关资源进行链接检查的场景，尤其适合开发调试和结果收集分析。

使用方法和配置说明

前置条件

当前版本需依赖https://github.com/SeleniumHQ/docker-selenium%E8%BF%90%E8%A1%8CINSPIRE%E9%93%BE%E6%8E%A5%E6%A3%80%E6%9F%A5%E5%99%A8%E3%80%82

启动Selenium容器

bash
docker run --rm -p 4444:4444 -v /dev/shm:/dev/shm selenium/standalone-firefox:3.141.59-20201010

注意：目前INSPIRE链接检查器无API可用，因此采用Selenium方式实现。未来计划通过HTTP请求直接运行检查器，以提高速度、稳定性和效率，届时将不再需要Selenium容器。

命令选项

bash
Usage: linkage-checker [OPTIONS]

使用示例

正常运行

bash
pipenv run linkage-checker --output-path /example/results.json

启用调试功能

bash
pipenv run linkage-checker --enable-caching --browser-screenshots -v DEBUG --debug-mode

开发安装

本项目使用pipenv进行依赖管理，需先安装pipenv：

bash
pip3 install pipenv

安装步骤

1. 克隆项目代码
2. 运行安装命令：

bash
PIPENV_VENV_IN_PROJECT=1 pipenv install --python 3.8 --dev

若本地无Python 3.8，需通过https://github.com/pyenv/pyenv%E5%AE%89%E8%A3%85%EF%BC%8C%E5%AE%89%E8%A3%85%E6%96%B9%E6%B3%95%E8%A7%81%E4%B8%8B%E6%96%87%E3%80%82

运行脚本

bash
pipenv run linkage-checker

脚本入口为linkage-checker/scripts.py的main()函数，可在setup.py的entry_points中配置。

代码格式化

使用black工具进行代码格式化：

bash
pipenv run black linkage_checker

测试

运行测试（包含pyflakes检查、black格式检查和覆盖率报告）：

bash
pipenv run pytest

添加依赖

在setup.py的install_requires中添加新依赖后，重新安装：

bash
pipenv install --dev

发布

项目使用zest.releaser进行发布，执行以下命令启动完整发布流程：

bash
pipenv run fullrelease

流程中所有提示可直接按Enter键使用默认值。

安装pyenv

安装依赖包

bash
sudo apt-get install -y make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libffi-dev liblzma-dev

安装pyenv

bash
curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash

配置环境

按安装提示将pyenv添加到.bashrc或.zshrc中。