VERIS 项目使用教程

VERIS 项目使用教程

veris Vocabulary for Event Recording and Incident Sharing (VERIS) 项目地址: https://gitcode.com/gh_mirrors/ve/veris

1. 项目目录结构及介绍

VERIS 项目的目录结构如下：

veris/
├── bin/
│   ├── build_standard_excel.py
│   ├── checkValidity.py
│   ├── convert-1.3.py
│   ├── convert_1.3_X_to_1.3_Y.py
│   ├── import_stdexcel.py
│   ├── import_veris.py
│   ├── mergeSchema.py
│   ├── rules.py
│   ├── update_labels.py
│   └── update_schema.py
├── tests/
├── verisframework.org/
├── LICENSE.txt
├── README.md
├── VERIS_Standard_Excel.xlsx
├── changelog
├── code_to_country.json
├── country_to_code.json
├── joined_veris_json.md
├── keynames-real.txt
├── mongoimport-all.txt
├── verify_keys.py
├── veris_style_guide.md
├── verisc-enum.json
├── verisc-labels.json
├── verisc-merged.json
├── verisc.json
└── verisc.jsonld

目录结构介绍

• bin/: 包含项目的脚本文件，用于构建、验证、转换和导入数据。
• tests/: 包含项目的单元测试文件。
• verisframework.org/: 可能包含与 VERIS 框架相关的文档或资源。
• LICENSE.txt: 项目的许可证文件。
• README.md: 项目的介绍和使用说明。
• VERIS_Standard_Excel.xlsx: 标准 Excel 文件，用于生成可导入的数据。
• changelog: 项目的变更日志。
• code_to_country.json: 国家代码映射文件。
• country_to_code.json: 国家代码映射文件。
• joined_veris_json.md: 解释合并的 VERIS 格式。
• keynames-real.txt: 实际键名列表。
• mongoimport-all.txt: MongoDB 导入脚本。
• verify_keys.py: 验证键的脚本。
• veris_style_guide.md: VERIS 编码风格指南。
• verisc-enum.json: VERIS 允许的枚举定义。
• verisc-labels.json: 枚举描述列表。
• verisc-merged.json: 合并的 JSON 模式文件。
• verisc.json: JSON 模式定义文件。
• verisc.jsonld: JSON-LD 格式的 VERIS 模式文件。

2. 项目启动文件介绍

VERIS 项目没有明确的“启动文件”，因为它主要是一个数据处理和验证工具集。项目的核心功能通过 bin/ 目录中的脚本来实现。以下是一些关键脚本的介绍：

• bin/build_standard_excel.py: 读取合并的模式文件并生成 VERIS_Standard_Excel.xlsx 文件。
• bin/checkValidity.py: 用于验证 JSON 记录是否符合模式文件的脚本。
• bin/import_veris.py: 用于将 CSV 文件导入为 JSON 的脚本。

3. 项目配置文件介绍

VERIS 项目的配置主要通过 JSON 文件和脚本来实现。以下是一些关键配置文件的介绍：

• verisc.json: 项目的 JSON 模式定义文件，定义了 VERIS 数据的结构和验证规则。
• verisc-labels.json: 包含枚举的描述信息，用于生成文档或用户界面。
• verisc-enum.json: 定义了 VERIS 中允许的枚举值。
• VERIS_Standard_Excel.xlsx: 标准 Excel 文件，用于生成可导入的数据。

这些配置文件和脚本共同构成了 VERIS 项目的核心功能，用户可以通过这些文件和脚本来处理和验证 VERIS 数据。

veris Vocabulary for Event Recording and Incident Sharing (VERIS) 项目地址: https://gitcode.com/gh_mirrors/ve/veris