Excel2JSON 教程

1. 项目目录结构及介绍

在 excel2json 开源项目中，典型的目录结构如下：

excel2json/
│
├── README.md       # 项目说明文件
├── setup.py        # 安装脚本
├── excel2json.py   # 主要功能模块
├── tests/          # 测试目录
│   └── test.py      # 单元测试文件
└── examples/       # 示例文件夹
    ├── input/      # 输入的 Excel 文件
    └── output/     # 输出的 JSON 文件

• README.md: 项目的基本信息和使用指南。
• setup.py: Python 包安装配置脚本，用于安装项目依赖和发布到 PyPI。
• excel2json.py: 核心代码，实现了从 Excel 到 JSON 的转换功能。
• tests/: 存放测试代码，用于验证功能正确性。
• examples/: 提供输入输出示例，帮助用户理解如何使用。

2. 项目的启动文件介绍

主要的启动文件是 excel2json.py。该脚本包含了核心转换功能和命令行接口（CLI）。用户可以通过以下方式直接调用它进行转换操作：

python excel2json.py --file /path/to/input.xlsx --output /path/to/output.json

这里的参数说明：

• --file: 指定待转换的 Excel 文件路径。
• --output: 设置转换后的 JSON 文件输出路径。

3. 项目的配置文件介绍

excel2json 项目本身并不依赖配置文件，但如果你希望自定义一些行为或扩展其功能，可以创建自己的 Python 脚本来导入并调用 excel2json 模块。例如，你可以创建一个 config.py 文件来存储自定义设置或额外处理逻辑，并在主程序中引入这些配置：

# config.py
from excel2json import convert_from_file

CUSTOM_SETTINGS = {
    'ignore_columns': ['ColumnToIgnore'],  # 可以忽略的列名列表
}

def custom_convert(excel_path, json_path):
    convert_from_file(excel_path, json_path, **CUSTOM_SETTINGS)

然后，在你的应用入口（如 main.py）中使用这个自定义的转换方法：

# main.py
import sys
from config import custom_convert

if __name__ == "__main__":
    if len(sys.argv) != 3:
        print("Usage: python main.py <excel-file> <json-file>")
        sys.exit(1)

    excel_file = sys.argv[1]
    json_file = sys.argv[2]

    custom_convert(excel_file, json_file)

这使得在不改变原始 excel2json.py 的基础上，能够方便地添加额外的配置选项和业务逻辑。