Matryoshka-MM 项目启动与配置教程

1. 项目目录结构及介绍

Matryoshka-MM 项目采用模块化的目录结构，以保持代码的清晰和可维护性。以下是项目的主要目录和文件介绍：

matryoshka-mm/
│
├── .gitignore          # 忽略文件列表
├── README.md           # 项目说明文件
├── requirements.txt    # 项目依赖列表
│
├── src/                # 源代码目录
│   ├── __init__.py     # 初始化文件
│   ├── main.py         # 项目主程序
│   └── utils/          # 工具类目录
│       ├── __init__.py
│       └── helpers.py  # 辅助函数
│
└── config/             # 配置文件目录
    ├── __init__.py
    └── settings.py     # 配置文件

• .gitignore：指定 Git 应该忽略的文件和目录。
• README.md：包含项目的描述、安装和使用说明。
• requirements.txt：列出项目依赖的 Python 包。
• src：存放项目的主要代码。
  • main.py：项目的主入口文件。
  • utils：存放辅助工具类和函数。
• config：存放项目的配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/main.py。以下是启动文件的简要介绍：

# main.py

from utils.helpers import setup_logging
from config.settings import get_config

def main():
    # 配置日志
    setup_logging()
    
    # 加载配置
    config = get_config()
    
    # 执行项目逻辑
    # ...

if __name__ == "__main__":
    main()

main.py 负责初始化日志系统，加载配置文件，并执行项目的主要逻辑。

3. 项目的配置文件介绍

项目的配置文件位于 config/settings.py。该文件定义了项目运行所需的配置项。以下是配置文件的基本结构：

# settings.py

import os

# 基础配置
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

# 日志配置
LOG_LEVEL = 'INFO'
LOG_FILE = os.path.join(BASE_DIR, 'logs', 'app.log')

# 其他配置项
# ...

def get_config():
    return {
        'base_dir': BASE_DIR,
        'log_level': LOG_LEVEL,
        'log_file': LOG_FILE,
        # 其他配置
    }

settings.py 中包含了项目的日志配置、基础目录等配置项。这些配置项可以通过 get_config() 函数获取，并在项目中被使用。