org.salsadigitalau/merlin框架

此软件包的最新版本(1.1.0)没有可用的许可信息。

开源迁移框架(标记到结构化数据)

1.1.0 2022-10-28 04:36 UTC

README

CircleCI License

欢迎使用Merlin,这是一个简单的工具,用于帮助将任意来源的内容迁移到结构化格式,以便其他系统消费。

详细文档可以在https://salsadigitalauorg.github.io/merlin-framework/找到。

要求

  • PHP > 7.2
  • Composer(可选)

安装

Merlin框架预计将作为独立的可执行文件使用,这可以本地化到您的项目或全局安装并添加到您的路径。要下载,请访问发布页面并下载最新的捆绑.phar可执行文件。

curl -s https://github.com/salsadigitalauorg/merlin-framework/releases \
| grep "merlin-framework" \
| cut -d : -f 2,3 \
| tr -d \" \
| wget -qi -

Composer依赖

Merlin也可以作为composer依赖项安装,这会更改应用程序在您的项目中的执行方式。

添加仓库

"repositories": [
  {
    "type": "vcs",
    "url": "https://github.com/salsadigitalauorg/merlin-framework"
  }
]

添加依赖

composer require salsadigitalauorg/merlin-framework

使用方法

有两个主要命令:crawlgenerate

  • crawl 会运行爬取域名并找到要迁移的域名上的URL。有关更多信息,请阅读爬虫文档并查看示例
  • generate 将根据映射配置生成结构化输出。有关更多信息,请阅读迁移文档并查看示例

要运行框架,您需要指定一个命令(例如 crawl 或 generate)、一个配置yaml文件以及输出路径,例如

merlin crawl -c <path/to/crawler-config.yml> -o <path/to/output>
merlin generate -c <path/to/migrate-config.yml> -o <path/to/output>

配置文件

配置文件应被视为架构文件,其中包含将内容HTML表示转换为结构化JSON的路径、域名和映射信息。

示例配置文件可以在示例中找到。

测试

自动测试套件将测试标准配置值与代表性的HTML结构进行比较,以确保工具可以正确构建JSON结构。

运行测试

./vendor/bin/phpunit

支持

我们鼓励您通过github问题队列提交问题。

许可

License