WatchDog 项目使用教程

1. 项目目录结构及介绍

WatchDog/
├── app/
│   ├── __init__.py
│   ├── main.py
│   ├── config.py
│   ├── utils/
│   │   ├── __init__.py
│   │   ├── helpers.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── user.py
│   ├── routes/
│   │   ├── __init__.py
│   │   ├── auth.py
│   │   ├── api.py
├── tests/
│   ├── __init__.py
│   ├── test_main.py
├── .env
├── .gitignore
├── README.md
├── requirements.txt
├── setup.py

目录结构说明

• app/: 项目的主要代码目录。
  • init.py: 使 app 成为一个 Python 包。
  • main.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • utils/: 存放项目中使用的工具函数。
  • models/: 存放数据库模型文件。
  • routes/: 存放路由处理文件。
• tests/: 存放项目的测试文件。
• .env: 环境变量配置文件。
• .gitignore: Git 忽略文件配置。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖包列表。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

app/main.py

main.py 是项目的启动文件，负责初始化应用并启动服务器。以下是文件的主要内容：

from flask import Flask
from app.config import Config
from app.routes import auth, api

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

app.register_blueprint(auth.bp)
app.register_blueprint(api.bp)

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

主要功能

• 初始化 Flask 应用: 使用 Flask 类初始化应用。
• 加载配置: 从 config.py 中加载配置。
• 注册蓝图: 注册 auth 和 api 蓝图，用于处理不同的路由。
• 启动服务器: 在开发环境下启动 Flask 服务器。

3. 项目的配置文件介绍

app/config.py

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:///app.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

主要配置项

• SECRET_KEY: 用于加密的密钥，可以从环境变量中获取，如果没有则使用默认值。
• SQLALCHEMY_DATABASE_URI: 数据库连接字符串，可以从环境变量中获取，如果没有则使用默认的 SQLite 数据库。
• SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪数据库修改，设置为 False 以提高性能。

.env

.env 文件用于存储环境变量，通常包含敏感信息，如数据库密码、API 密钥等。以下是一个示例：

SECRET_KEY=your_secret_key
DATABASE_URL=postgresql://user:password@localhost/dbname

使用方法

在项目启动前，确保 .env 文件已正确配置，并使用 python-dotenv 库加载环境变量：

from dotenv import load_dotenv
load_dotenv()

通过以上步骤，您可以顺利启动并配置 WatchDog 项目。