Bon 项目使用教程

1. 项目目录结构及介绍

bon/
├── README.md
├── bon.py
├── config.ini
├── docs/
│   ├── index.md
│   └── ...
├── src/
│   ├── main.py
│   ├── utils.py
│   └── ...
├── tests/
│   ├── test_main.py
│   └── ...
└── requirements.txt

• README.md: 项目介绍文件，包含项目的基本信息、安装步骤和使用说明。
• bon.py: 项目的启动文件，负责初始化和启动整个项目。
• config.ini: 项目的配置文件，包含项目的各种配置参数。
• docs/: 项目文档目录，包含项目的详细文档和使用说明。
• src/: 项目源代码目录，包含项目的主要功能实现。
• tests/: 项目测试代码目录，包含项目的单元测试和集成测试。
• requirements.txt: 项目依赖文件，列出了项目运行所需的Python包。

2. 项目启动文件介绍

bon.py

bon.py 是项目的启动文件，负责初始化和启动整个项目。以下是该文件的主要功能：

• 初始化配置: 读取 config.ini 文件中的配置参数，并初始化项目配置。
• 启动主程序: 调用 src/main.py 中的主程序，启动项目的核心功能。
• 日志记录: 初始化日志系统，记录项目的运行状态和错误信息。

3. 项目配置文件介绍

config.ini

config.ini 是项目的配置文件，包含项目的各种配置参数。以下是该文件的主要内容：

[General]
debug = True
log_level = INFO

[Database]
host = localhost
port = 3306
username = root
password = password
database = bon_db

[API]
url = http://localhost:8000
timeout = 10

• General: 通用配置，包含调试模式和日志级别等参数。
• Database: 数据库配置，包含数据库的连接信息。
• API: API配置，包含API的URL和超时时间等参数。

通过修改 config.ini 文件中的参数，可以调整项目的运行行为和配置。