Harbeth 开源项目使用教程

1. 项目目录结构及介绍

Harbeth 项目的目录结构如下：

Harbeth/
├── Harbeth/
│   ├── Assets/
│   ├── Classes/
│   ├── Config/
│   ├── Controllers/
│   ├── Models/
│   ├── Views/
│   ├── main.py
│   └── settings.py
├── README.md
├── requirements.txt
└── setup.py

目录介绍

• Harbeth/: 项目的主目录，包含了项目的所有核心代码。

  • Assets/: 存放静态资源文件，如图片、CSS、JavaScript 等。
  • Classes/: 存放项目的类文件，通常包含一些基础类和工具类。
  • Config/: 存放项目的配置文件，如数据库配置、日志配置等。
  • Controllers/: 存放控制器文件，负责处理用户请求和业务逻辑。
  • Models/: 存放数据模型文件，定义了数据库表结构和数据操作。
  • Views/: 存放视图文件，负责渲染用户界面。
  • main.py: 项目的启动文件。
  • settings.py: 项目的全局配置文件。

• README.md: 项目的说明文档，通常包含项目的简介、安装步骤、使用说明等。

• requirements.txt: 项目的依赖文件，列出了项目运行所需的 Python 包。

• setup.py: 项目的安装脚本，用于安装项目及其依赖。

2. 项目的启动文件介绍

项目的启动文件是 main.py，它负责启动整个应用程序。以下是 main.py 的基本结构和功能介绍：

from flask import Flask
from Config import config
from Controllers import routes

app = Flask(__name__)
app.config.from_object(config)

# 注册路由
app.register_blueprint(routes.bp)

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

功能介绍

• 导入模块: 导入了 Flask 框架、配置文件和路由模块。
• 创建 Flask 应用: 使用 Flask(__name__) 创建了一个 Flask 应用实例。
• 加载配置: 通过 app.config.from_object(config) 加载了配置文件中的配置。
• 注册路由: 使用 app.register_blueprint(routes.bp) 注册了路由模块。
• 启动应用: 在 if __name__ == "__main__": 条件下，使用 app.run(debug=True) 启动应用，并开启调试模式。

3. 项目的配置文件介绍

项目的配置文件是 settings.py，它包含了项目的全局配置信息。以下是 settings.py 的基本结构和功能介绍：

import os

class Config:
    DEBUG = False
    TESTING = False
    DATABASE_URI = os.getenv('DATABASE_URI', 'sqlite:///default.db')

class DevelopmentConfig(Config):
    DEBUG = True

class TestingConfig(Config):
    TESTING = True
    DATABASE_URI = 'sqlite:///test.db'

class ProductionConfig(Config):
    DATABASE_URI = os.getenv('DATABASE_URI')

config = {
    'development': DevelopmentConfig,
    'testing': TestingConfig,
    'production': ProductionConfig,
    'default': DevelopmentConfig
}

功能介绍

• Config 类: 定义了项目的默认配置，包括调试模式、测试模式和数据库 URI。
• DevelopmentConfig 类: 继承自 Config，用于开发环境的配置，开启了调试模式。
• TestingConfig 类: 继承自 Config，用于测试环境的配置，开启了测试模式，并指定了测试数据库。
• ProductionConfig 类: 继承自 Config，用于生产环境的配置，从环境变量中获取数据库 URI。
• config 字典: 定义了不同环境的配置类，并指定默认配置为开发环境。

通过以上配置文件，可以根据不同的环境（开发、测试、生产）加载不同的配置，从而实现灵活的项目部署和管理。