SiteScan 项目使用教程

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

SiteScan 项目的目录结构如下：

SiteScan/
├── docs/
│   ├── README.md
│   └── CONTRIBUTING.md
├── src/
│   ├── main.py
│   ├── config.py
│   └── utils/
│       ├── helper.py
│       └── logger.py
├── tests/
│   ├── test_main.py
│   └── test_config.py
├── .gitignore
├── LICENSE
└── requirements.txt

目录介绍

• docs/: 包含项目的文档文件，如 README.md 和 CONTRIBUTING.md。
• src/: 项目的源代码目录，包含主要的启动文件和配置文件，以及其他实用工具。
• tests/: 包含项目的测试文件。
• .gitignore: Git 忽略文件。
• LICENSE: 项目的许可证文件。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

项目的启动文件位于 src/main.py。该文件是整个项目的入口点，负责初始化项目并启动主要功能。

main.py 主要功能

• 加载配置文件。
• 初始化日志系统。
• 启动主要业务逻辑。

3. 项目的配置文件介绍

项目的配置文件位于 src/config.py。该文件包含项目的所有配置选项，如数据库连接、日志级别等。

config.py 主要内容

• 数据库配置: 包括数据库地址、用户名、密码等。
• 日志配置: 包括日志级别、日志文件路径等。
• 其他配置: 如 API 密钥、服务地址等。

通过以上介绍，您可以更好地理解和使用 SiteScan 项目。希望本教程对您有所帮助！