WHAM 项目使用教程

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

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

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

2. 项目的启动文件介绍

src/main.py

main.py 是项目的入口文件，负责启动整个应用程序。以下是 main.py 的基本结构：

import config
from utils.logger import setup_logger

def main():
    logger = setup_logger()
    logger.info("Application started")
    # 其他初始化代码

if __name__ == "__main__":
    main()

• 导入配置: 导入 config.py 中的配置。
• 设置日志: 使用 utils.logger.setup_logger 设置日志。
• 主函数: main 函数是程序的入口点，负责初始化和启动应用。

3. 项目的配置文件介绍

src/config.py

config.py 文件包含项目的配置信息，如数据库连接、日志级别等。以下是 config.py 的基本结构：

import os

class Config:
    DEBUG = os.getenv('DEBUG', False)
    LOG_LEVEL = os.getenv('LOG_LEVEL', 'INFO')
    DATABASE_URI = os.getenv('DATABASE_URI', 'sqlite:///default.db')

config = Config()

• 环境变量: 使用 os.getenv 从环境变量中获取配置，提供默认值。
• 配置类: Config 类封装了所有配置项，便于管理和使用。
• 实例化配置: 创建 Config 类的实例 config，供其他模块导入使用。

以上是 WHAM 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。