**Django Simple History安装与使用指南**

Django Simple History安装与使用指南

django-simple-history Store model history and view/revert changes from admin site. 项目地址: https://gitcode.com/gh_mirrors/dj/django-simple-history

1. 项目目录结构及介绍

django-simple-history 是一个用于记录Django模型变更历史的扩展库。以下是该库的基本目录结构及其简介：

django-simple-history/
├── AUTHORS.rst          # 作者信息文件
├──.CHANGES.rst         # 变更日志
├── CODE_OF_CONDUCT.md   # 行为准则文件
├── CONTRIBUTORS.rst    # 贡献者列表
├── LICENSE.txt          # 许可证文件，采用BSD-3-Clause协议
├── Makefile             # 构建脚本
├── README.rst           # 项目的快速入门和概述文档
├── codecov.yml          # Codecov配置文件，用于代码覆盖率分析
├── config               # 额外配置相关（可能包含特定环境配置）
├── doc                  # 文档资料，包括API文档等
│   └── requirements.txt # 文档构建所需的依赖清单
├── pre-commit-config.yaml # Pre-commit配置文件，确保提交前代码质量
├── pyproject.toml       # 现代Python项目配置，替代传统的setup.py
├── requirements         # 不同环境下的依赖要求文件
│   └── base.txt         # 基础依赖
├── runtests.py          # 测试运行脚本
├── simple_history      # 主要源码模块，包含历史记录处理逻辑
│   ├── __init__.py
│   └── ...              # 其他相关Python源码文件
├── tests                # 测试套件存放目录
├── tox.ini              # Tox多环境测试配置文件
└── ...

2. 项目的启动文件介绍

在django-simple-history中，并没有直接提供一个“启动文件”如传统意义上的main.py，因为这是一个Django应用插件，其集成到Django项目中是通过在Django的应用配置完成的。主要的集成步骤是在Django的settings.py文件中添加'simple_history'到INSTALLED_APPS列表中，以及配置相应的中间件和模型历史管理方式。

3. 项目的配置文件介绍

在Django的settings.py中的配置

• 添加至INSTALLED_APPS：

  INSTALLED_APPS = [
      # ...
      'simple_history',
      # ...
  ]
  

• 配置历史记录使用的Model Manager（可选）： 默认情况下，Django Simple History自动将历史记录管理器添加到你的模型中，但你可以通过在模型上设置history_manager_class来自定义。

• 更改中间件顺序（如果需要监听信号）： 确保Django Simple History的中间件位于其他修改数据的中间件之后。

MIDDLEWARE = [
    # Other middleware components...
    'simple_history.middleware.HistoryRequestMiddleware',  # 确定正确位置
    # More middleware...
]

自定义配置

在一些场景下，你可能需要在你的Django项目的配置文件里进行额外的定制，例如指定哪些字段不存储历史记录或者改变默认历史记录表名等。这些通常通过修改模型类或利用Django Simple History提供的选项来实现，而不是直接在settings.py进行复杂的配置。

通过上述介绍，开发者可以理解django-simple-history的基本架构，并按照其文档指示轻松地将其融入到自己的Django项目中，实现模型变化的跟踪与回溯功能。

django-simple-history Store model history and view/revert changes from admin site. 项目地址: https://gitcode.com/gh_mirrors/dj/django-simple-history