Radon 项目启动与配置教程

1. 项目目录结构及介绍

Radon 项目的目录结构如下所示：

radon/
├── .gitignore
├── .vscode
│   └── settings.json
├── README.md
├── radon
│   ├── __init__.py
│   ├── app.py
│   ├── config.py
│   ├── models.py
│   ├── routes.py
│   └── templates
│       ├── 404.html
│       ├── base.html
│       └── index.html
├── requirements.txt
└── run.py

• .gitignore：配置 Git 忽略文件列表，用于指定哪些文件和目录不应该被提交到 Git 仓库中。
• .vscode：Visual Studio Code 的配置文件夹，包含项目的特定设置。
• README.md：项目的说明文档，包含项目描述、安装和使用说明。
• radon：项目的主要文件夹，包含了项目的所有代码和资源文件。
  • __init__.py：初始化 Python 包。
  • app.py：项目的 Flask 应用程序主文件。
  • config.py：配置文件，用于存储和管理项目配置。
  • models.py：定义项目中的数据模型。
  • routes.py：定义 Flask 应用的路由和视图函数。
  • templates：存放 HTML 模板的目录。
• requirements.txt：项目依赖文件列表，包含了项目运行所需的第三方库。
• run.py：启动 Flask 应用的脚本。

2. 项目的启动文件介绍

项目的启动文件为 run.py，其内容如下：

from radon import app

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

该脚本从 radon 包中导入 app 对象，并在脚本作为主程序运行时，启动 Flask 应用。

3. 项目的配置文件介绍

项目的配置文件为 config.py，该文件定义了 Flask 应用程序所需的配置项，内容如下：

import os

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'a-very-secret-key'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or 'sqlite:///data.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    MAIL_SERVER = os.environ.get('MAIL_SERVER')
    MAIL_PORT = int(os.environ.get('MAIL_PORT') or 25)
    MAIL_USE_TLS = os.environ.get('MAIL_USE_TLS') is not None
    MAIL_USERNAME = os.environ.get('MAIL_USERNAME')
    MAIL_PASSWORD = os.environ.get('MAIL_PASSWORD')
    MAIL_SUBJECT_PREFIX = '[Radon]'
    MAIL_SENDER = 'Radon Admin <[e-mail]>'
    TESTING = False
    DEBUG = False

在这个配置文件中，定义了如下配置项：

• SECRET_KEY：用于 Flask 会话管理的安全密钥。
• SQLALCHEMY_DATABASE_URI：数据库的连接字符串。
• SQLALCHEMY_TRACK_MODIFICATIONS：关闭 SQLALCHEMY 的自动跟踪修改特性，减少内存使用。
• MAIL_SERVER、MAIL_PORT、MAIL_USE_TLS、MAIL_USERNAME、MAIL_PASSWORD：邮件服务器的配置。
• MAIL_SUBJECT_PREFIX、MAIL_SENDER：邮件发送者信息和邮件主题前缀。
• TESTING、DEBUG：用于开启测试模式和调试模式。

根据项目的具体需求，开发者可以调整这些配置项，以满足实际部署的需求。