CMT 项目启动与配置教程

1. 项目目录结构及介绍

CMT 项目目录结构如下：

CMT/
├── .gitignore
├── Dockerfile
├── README.md
├── app/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── models.py
│   ├── routes.py
│   └── utils.py
├── tests/
│   ├── __init__.py
│   └── test_main.py
└── requirements.txt

• .gitignore：用于 Git 仓库中指定无需提交的文件和目录。
• Dockerfile：用于创建项目的 Docker 容器镜像。
• README.md：项目的说明文档，通常包含项目信息、安装和使用说明等。
• app/：项目的核心代码目录。
  • init.py：Python 包初始化文件，用于将目录作为包处理。
  • main.py：项目的主要启动文件。
  • config.py：项目配置文件。
  • models.py：定义数据库模型。
  • routes.py：定义项目路由。
  • utils.py：项目工具函数。
• tests/：项目的测试代码目录。
  • init.py：测试包初始化文件。
  • test_main.py：主功能的测试脚本。
• requirements.txt：列出项目运行所需的 Python 包依赖。

2. 项目的启动文件介绍

项目的启动文件是 app/main.py。以下是启动文件的主要内容：

from app import create_app

app = create_app()

if __name__ == "__main__":
    app.run()

这段代码首先从 app 模块中导入 create_app 函数，然后调用它来创建 Flask 应用对象。if __name__ == "__main__": 确保当文件作为主程序运行时，才执行 app.run() 来启动应用。

3. 项目的配置文件介绍

项目的配置文件是 app/config.py。这个文件通常用于定义项目运行所需的各种配置信息，例如数据库连接信息、应用密钥等。以下是一个示例配置：

import os

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'you-will-never-guess'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or 'sqlite:///example.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    ...

在这个配置类中，定义了几个基本配置，如 SECRET_KEY 用于 Flask 应用的会话安全，SQLALCHEMY_DATABASE_URI 定义了数据库的连接字符串。使用环境变量可以方便地在不同环境下使用不同的配置值。