NAO 开源项目教程

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

NAO 项目的目录结构如下：

nao/
├── README.md
├── nao.py
├── config/
│   ├── default.yaml
│   └── production.yaml
├── src/
│   ├── __init__.py
│   └── main.py
└── tests/
    ├── __init__.py
    └── test_main.py

• README.md: 项目说明文档。
• nao.py: 项目的主启动文件。
• config/: 配置文件目录，包含默认配置和生产环境配置。
• src/: 源代码目录，包含项目的主要功能实现。
• tests/: 测试代码目录，包含项目的单元测试。

2. 项目的启动文件介绍

nao.py 是项目的启动文件，主要负责初始化项目并启动主程序。以下是 nao.py 的主要内容：

import sys
from src.main import main

if __name__ == "__main__":
    sys.exit(main())

• import sys: 导入系统模块，用于处理系统相关的操作。
• from src.main import main: 从 src 目录中导入 main 函数。
• if __name__ == "__main__":: 判断当前脚本是否作为主程序运行。
• sys.exit(main()): 调用 main 函数并退出程序。

3. 项目的配置文件介绍

配置文件位于 config 目录下，包含 default.yaml 和 production.yaml 两个文件。

default.yaml

默认配置文件，包含项目的默认设置：

database:
  host: localhost
  port: 3306
  user: root
  password: root
  name: nao_db

production.yaml

生产环境配置文件，包含生产环境的特定设置：

database:
  host: production_db_host
  port: 3306
  user: production_user
  password: production_password
  name: nao_production_db

这两个配置文件通过不同的环境变量加载，以适应不同的运行环境。