CourseArragement 项目教程

1. 项目目录结构及介绍

CourseArragement/
├── README.md
├── src/
│   ├── main.py
│   ├── config.py
│   ├── utils/
│   │   ├── helper.py
│   │   └── logger.py
│   └── modules/
│       ├── course.py
│       └── student.py
├── tests/
│   ├── test_course.py
│   └── test_student.py
└── requirements.txt

目录结构说明

• README.md: 项目的说明文档，包含项目的基本信息、安装步骤和使用说明。
• src/: 项目的源代码目录。
  • main.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • utils/: 包含项目的工具函数和辅助模块。
    • helper.py: 辅助函数模块。
    • logger.py: 日志记录模块。
  • modules/: 包含项目的核心功能模块。
    • course.py: 课程管理模块。
    • student.py: 学生管理模块。
• tests/: 包含项目的测试代码。
  • test_course.py: 课程管理模块的测试代码。
  • test_student.py: 学生管理模块的测试代码。
• requirements.txt: 项目依赖的Python包列表。

2. 项目启动文件介绍

src/main.py

main.py 是项目的启动文件，负责初始化项目并启动主程序。以下是该文件的主要功能：

• 导入依赖: 导入项目所需的模块和配置。
• 初始化配置: 读取并加载配置文件 config.py 中的配置项。
• 启动主程序: 调用 modules 目录下的功能模块，启动项目的核心功能。

# src/main.py

import config
from modules.course import CourseManager
from modules.student import StudentManager

def main():
    # 初始化配置
    config.load_config()
    
    # 启动课程管理模块
    course_manager = CourseManager()
    course_manager.start()
    
    # 启动学生管理模块
    student_manager = StudentManager()
    student_manager.start()

if __name__ == "__main__":
    main()

3. 项目配置文件介绍

src/config.py

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

• 数据库配置: 数据库连接信息。
• 日志配置: 日志记录的级别和输出路径。
• 其他配置: 其他自定义配置项。

# src/config.py

import os

def load_config():
    global DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, LOG_LEVEL, LOG_PATH
    
    DB_HOST = os.getenv('DB_HOST', 'localhost')
    DB_PORT = os.getenv('DB_PORT', '3306')
    DB_USER = os.getenv('DB_USER', 'root')
    DB_PASSWORD = os.getenv('DB_PASSWORD', 'password')
    
    LOG_LEVEL = os.getenv('LOG_LEVEL', 'INFO')
    LOG_PATH = os.getenv('LOG_PATH', 'logs/app.log')

# 其他配置项...

通过以上配置文件，项目可以根据不同的环境变量加载不同的配置，从而实现灵活的配置管理。