reconcile-csv 项目使用教程

reconcile-csv 项目使用教程

reconcile-csv A simple OpenRefine reconciliation service that runs on top of a CSV file 项目地址: https://gitcode.com/gh_mirrors/re/reconcile-csv

1. 项目的目录结构及介绍

reconcile-csv 项目的目录结构如下：

reconcile-csv/
├── dist/
│   └── reconcile-csv-0.1.0-SNAPSHOT-standalone.jar
├── src/
│   └── reconcile_csv/
│       ├── gitignore
│       ├── LICENSE
│       ├── README.md
│       ├── index.html.tpl
│       ├── project.clj
│       └── reconcile-csv-0.1.0-SNAPSHOT-standalone.jar
├── .gitignore
├── LICENSE
├── README.md
├── index.html.tpl
└── project.clj

目录结构介绍

• dist/: 包含预编译的 JAR 文件 reconcile-csv-0.1.0-SNAPSHOT-standalone.jar，可以直接用于启动服务。
• src/reconcile_csv/: 包含项目的源代码文件。
  • gitignore: Git 忽略文件配置。
  • LICENSE: 项目许可证文件。
  • README.md: 项目说明文档。
  • index.html.tpl: 项目的前端模板文件。
  • project.clj: Leiningen 项目配置文件。
  • reconcile-csv-0.1.0-SNAPSHOT-standalone.jar: 预编译的 JAR 文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• index.html.tpl: 项目的前端模板文件。
• project.clj: Leiningen 项目配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 dist/reconcile-csv-0.1.0-SNAPSHOT-standalone.jar 和 src/reconcile_csv/reconcile-csv-0.1.0-SNAPSHOT-standalone.jar。这两个文件是预编译的 JAR 文件，可以直接用于启动服务。

启动方式

使用预编译的 JAR 文件启动

java -Xmx2g -jar reconcile-csv-0.1.0-SNAPSHOT-standalone.jar <file> <primary search column> <column with id's>

使用 Leiningen 启动

lein run <file> <primary search column> <column with id's>

3. 项目的配置文件介绍

项目的配置文件主要是 project.clj，这是一个 Leiningen 项目配置文件，用于定义项目的依赖、插件和其他配置。

project.clj 文件内容示例

(defproject reconcile-csv "0.1.0-SNAPSHOT"
  :description "A simple OpenRefine reconciliation service that runs on top of a CSV file"
  :url "https://github.com/rufuspollock-okfn/reconcile-csv"
  :license {:name "BSD-2-Clause"
            :url "https://opensource.org/licenses/BSD-2-Clause"}
  :dependencies [[org.clojure/clojure "1.8.0"]]
  :main ^:skip-aot reconcile-csv.core
  :target-path "target/%s"
  :profiles {:uberjar {:aot :all}})

配置文件介绍

• defproject: 定义项目的名称和版本。
• description: 项目的描述。
• url: 项目的 GitHub 仓库地址。
• license: 项目的许可证信息。
• dependencies: 项目的依赖库。
• main: 定义项目的主入口点。
• target-path: 定义编译后的目标路径。
• profiles: 定义项目的不同构建配置。

通过以上配置文件，可以管理项目的依赖、构建和运行环境。

reconcile-csv A simple OpenRefine reconciliation service that runs on top of a CSV file 项目地址: https://gitcode.com/gh_mirrors/re/reconcile-csv