B.M.B-XMD 项目启动与配置教程

1. 项目目录结构及介绍

B.M.B-XMD 项目目录结构如下：

B.M.B-XMD/
│
├── .gitignore                # 忽略文件列表
├── README.md                 # 项目说明文件
│
├── config/                   # 配置文件目录
│   ├── config.json           # 项目配置文件
│   └── ...
│
├── src/                      # 源代码目录
│   ├── main.py               # 主程序文件
│   ├── ...
│   └── ...
│
├── tools/                    # 工具类目录
│   ├── utils.py              # 工具函数文件
│   └── ...
│
└── tests/                    # 测试代码目录
    ├── test_main.py          # 主程序测试文件
    └── ...

• .gitignore：Git 忽略文件，用于指定在执行 Git 命令时应该忽略的文件和目录。
• README.md：项目说明文件，提供项目的基本信息和说明。
• config/：配置文件目录，存放项目的配置文件。
• src/：源代码目录，包含项目的主要代码文件。
• tools/：工具类目录，存放一些通用的工具类或函数。
• tests/：测试代码目录，包含对项目代码的测试用例。

2. 项目的启动文件介绍

项目的启动文件为 src/main.py。该文件是项目的主程序入口，通常包含以下内容：

import sys
from config.config import Config

# 加载配置文件
config = Config()

def main():
    # 主程序逻辑
    print("B.M.B-XMD 项目启动")

if __name__ == "__main__":
    main()

在 main.py 中，我们首先从配置文件目录中导入配置信息，然后在 main 函数中编写项目的主要执行逻辑。

3. 项目的配置文件介绍

项目的配置文件为 config/config.json，该文件通常用于存放项目的配置信息，如数据库连接信息、API 密钥等。配置文件的内容如下：

{
    "database": {
        "host": "localhost",
        "port": 3306,
        "user": "root",
        "password": "password",
        "dbname": "bmb_xmd"
    },
    "api_keys": {
        "key1": "value1",
        "key2": "value2"
    }
}

在项目中，可以通过以下方式读取配置文件：

import json

class Config:
    def __init__(self):
        with open('config/config.json', 'r') as f:
            self.config = json.load(f)

    def get_database_config(self):
        return self.config['database']

    def get_api_key(self, key_name):
        return self.config['api_keys'].get(key_name, None)

这样，我们就可以在项目中方便地访问和使用配置文件中的信息了。