InputSourcePro 项目启动与配置教程

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

InputSourcePro 项目的目录结构如下：

InputSourcePro/
├── .gitignore
├── config/
│   ├── default.json
│   └── dev.json
├── docs/
│   └── README.md
├── src/
│   ├── main.py
│   ├── utils/
│   │   └── helper.py
│   └── tests/
│       └── test_main.py
└── requirements.txt

• .gitignore: 指定在 Git 仓库中忽略的文件和目录。
• config/: 存放配置文件。
  • default.json: 默认配置文件。
  • dev.json: 开发环境使用的配置文件。
• docs/: 存放项目文档。
  • README.md: 项目的基本介绍和使用说明。
• src/: 项目源代码目录。
  • main.py: 项目的主入口文件。
  • utils/: 存放工具类的目录。
    • helper.py: 辅助工具类的文件。
  • tests/: 存放测试代码的目录。
    • test_main.py: 主程序测试文件。
• requirements.txt: 项目依赖的第三方库列表。

2. 项目的启动文件介绍

项目的启动文件是 src/main.py。以下是 main.py 文件的主要内容：

import json
from utils.helper import Helper

def main():
    # 加载配置文件
    with open('config/default.json', 'r', encoding='utf-8') as f:
        config = json.load(f)

    # 创建 Helper 实例
    helper = Helper(config)

    # 执行主程序逻辑
    helper.run()

if __name__ == '__main__':
    main()

main.py 负责初始化配置文件，创建 Helper 实例，并调用 run 方法执行主程序逻辑。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，包括 default.json 和 dev.json 两个文件。

• default.json 是默认配置文件，包含了项目运行的基本配置信息。以下是一个示例：

{
    "host": "0.0.0.0",
    "port": 8080,
    "debug": false
}

• dev.json 是开发环境使用的配置文件，通常用于调整开发环境中的特定配置。例如：

{
    "host": "localhost",
    "port": 8081,
    "debug": true
}

在实际使用中，可以根据需要选择加载 default.json 或 dev.json 配置文件。