WnStock 开源项目教程

WnStock 开源项目教程

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

WnStock 项目的目录结构如下：

WnStock/
├── README.md
├── docs/
│   ├── index.md
│   └── ...
├── src/
│   ├── main.py
│   ├── config.py
│   └── ...
├── tests/
│   ├── test_main.py
│   └── ...
├── requirements.txt
└── .gitignore

目录介绍

• README.md: 项目介绍文档。
• docs/: 存放项目文档文件。
• src/: 存放项目源代码文件。
• tests/: 存放测试代码文件。
• requirements.txt: 项目依赖文件。
• .gitignore: Git 忽略文件配置。

2. 项目的启动文件介绍

项目的启动文件是 src/main.py。该文件包含了项目的主要入口点，负责初始化应用并启动服务。

# src/main.py

import config
from app import create_app

def main():
    app = create_app(config)
    app.run()

if __name__ == "__main__":
    main()

启动文件功能

• 导入配置: 从 config.py 导入配置信息。
• 创建应用: 调用 create_app 函数创建应用实例。
• 运行应用: 启动应用服务。

3. 项目的配置文件介绍

项目的配置文件是 src/config.py。该文件包含了项目的各种配置信息，如数据库连接、日志设置等。

# src/config.py

import os

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'hard_to_guess_string'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URI') or 'sqlite:///data.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

class DevelopmentConfig(Config):
    DEBUG = True

class ProductionConfig(Config):
    DEBUG = False

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

配置文件功能

• 基本配置: 定义了 SECRET_KEY 和 SQLALCHEMY_DATABASE_URI 等基本配置。
• 开发配置: 定义了开发环境的配置，如 DEBUG 模式。
• 生产配置: 定义了生产环境的配置，如关闭 DEBUG 模式。
• 配置字典: 提供了一个配置字典，方便根据环境选择不同的配置。