django-pghistory安装与使用指南

1. 项目目录结构及介绍

django-pghistory 是一个用于Django应用的数据库历史追踪库，利用PostgreSQL的触发器来自动记录模型的变化，无需修改应用程序代码。以下是典型的项目结构概览，基于从GitHub克隆下来的仓库：

django-pghistory/
│
├── CHANGELOG.md         # 版本更新日志
├── LICENSE              # 许可证文件
├── README.md            # 项目简介
├── setup.py             # 包的安装脚本
├── django_pghistory     # 主要的源码目录
│   ├── __init__.py      # 初始化文件
│   ├── checks.py        # Django检查工具相关代码
│   ├── management       # 管理命令相关文件夹
│   ├── migrations       # 数据迁移文件夹
│   ├── models.py        # 历史模型定义
│   ├── signals.py       # Django信号处理
│   └── tests            # 单元测试文件夹
├── examples             # 示例项目或用法示例
├── requirements.txt     # 依赖列表
└── tox.ini              # Tox测试环境配置

• django_pghistory: 包含核心功能实现，如历史追踪模型、信号处理等。
• management: 自定义Django管理命令可能存放于此。
• migrations: 存储与该库相关的数据库迁移文件。
• tests: 提供测试案例以确保功能完整性和兼容性。

2. 项目的启动文件介绍

在实际使用中，而非直接操作django-pghistory项目本身，您需要将它作为Django应用的一个依赖引入到自己的项目中。因此，“启动文件”概念更多指的是您自己的Django项目的manage.py文件以及您的settings.py中的配置调整。

• manage.py: 这是每个Django项目的入口点，允许运行诸如迁移、创建超级用户等Django管理命令。引入django-pghistory后，并不需要对这个文件做任何改动，除非是要添加自定义的管理命令或执行特定的脚本。

3. 项目的配置文件介绍

主要涉及到的配置是在您的Django项目的settings.py文件中。

1. 添加到INSTALLED_APPS：为了启用django-pghistory，你需要在你的Django项目的settings.py文件的INSTALLED_APPS列表中添加'pghistory'。

   INSTALLED_APPS = [
       ...
       'pghistory',
       ...
   ]
   

2. 数据库设置：由于django-pghistory依赖于PostgreSQL的特性（特别是触发器），您需要确保您的数据库引擎设置为PostgreSQL。

   DATABASES = {
       'default': {
           'ENGINE': 'django.db.backends.postgresql',
           'NAME': 'your_database_name',
           'USER': 'your_username',
           'PASSWORD': 'your_password',
           'HOST': 'localhost',  # 或者远程主机地址
           'PORT': '',          # 默认端口通常是5432
       }
   }
   

3. 其他配置：根据具体需求，您可能还需要配置事件跟踪、上下文收集等相关设置，详情见django-pghistory的官方文档。

通过上述步骤，您可以成功地在Django项目中集成并配置django-pghistory，以便开始利用其提供的历史追踪功能。务必参考官方文档以获取更详细的配置选项和使用指导。