pd-select 项目使用教程

1. 项目目录结构及介绍

pd-select 项目的目录结构如下：

pd-select/
├── config/
│   ├── config.json
│   └── settings.py
├── src/
│   ├── main.py
│   ├── utils/
│   │   ├── helper.py
│   │   └── logger.py
│   └── models/
│       ├── user.py
│       └── product.py
├── tests/
│   ├── test_main.py
│   └── test_utils.py
├── README.md
└── requirements.txt

目录结构介绍

• config/: 存放项目的配置文件，包括 config.json 和 settings.py。
• src/: 项目的源代码目录，包含主要的业务逻辑和工具函数。
  • main.py: 项目的启动文件。
  • utils/: 存放各种工具函数和辅助模块。
    • helper.py: 通用工具函数。
    • logger.py: 日志记录模块。
  • models/: 存放数据模型定义。
    • user.py: 用户模型定义。
    • product.py: 产品模型定义。
• tests/: 存放项目的测试代码。
  • test_main.py: 针对 main.py 的测试代码。
  • test_utils.py: 针对 utils/ 目录下的工具函数的测试代码。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

项目的启动文件是 src/main.py。该文件负责初始化项目并启动主要的业务逻辑。以下是 main.py 的主要内容：

import os
from config.settings import load_config
from src.utils.logger import setup_logger
from src.models.user import User
from src.models.product import Product

def main():
    # 加载配置文件
    config = load_config()
    
    # 设置日志
    setup_logger(config['log_level'])
    
    # 初始化数据库连接
    User.initialize_db(config['db_uri'])
    Product.initialize_db(config['db_uri'])
    
    # 启动主逻辑
    print("项目启动成功！")

if __name__ == "__main__":
    main()

主要功能

• 加载配置文件: 通过 config.settings.load_config() 函数加载配置文件。
• 设置日志: 使用 src.utils.logger.setup_logger() 函数设置日志级别。
• 初始化数据库连接: 初始化用户和产品模型的数据库连接。
• 启动主逻辑: 打印启动成功的消息。

3. 项目的配置文件介绍

项目的配置文件存放在 config/ 目录下，主要包括 config.json 和 settings.py 两个文件。

config.json

config.json 是一个 JSON 格式的配置文件，包含项目的各种配置参数，例如数据库连接信息、日志级别等。以下是一个示例：

{
    "db_uri": "sqlite:///database.db",
    "log_level": "INFO",
    "api_key": "your_api_key_here"
}

settings.py

settings.py 是一个 Python 脚本，负责加载 config.json 文件并提供配置参数的访问接口。以下是 settings.py 的主要内容：

import json

def load_config():
    with open('config/config.json', 'r') as f:
        config = json.load(f)
    return config

主要功能

• 加载配置文件: load_config() 函数读取 config.json 文件并返回配置参数的字典。

通过以上配置文件，项目可以在不同的环境中灵活配置，例如开发环境、测试环境和生产环境。