Django-Simple-History 技术文档

1. 安装指南

安装依赖

首先，您需要确保您的环境中安装了以下依赖：

• Python 3.9及以上版本
• Django 4.2及以上版本

使用pip安装

通过pip命令，您可以轻松安装django-simple-history：

pip install django-simple-history

确保在安装前更新您的pip至最新版本：

pip install --upgrade pip

通过源码安装

如果您希望从源码安装，可以克隆GitHub仓库并运行安装脚本：

git clone https://github.com/jazzband/django-simple-history.git
cd django-simple-history
pip install .

2. 项目的使用说明

django-simple-history能够在每次模型的创建、更新或删除时保存Django模型的状态。这使得跟踪数据变化变得非常方便。

快速开始

1. 将'simple_history'添加到您的INSTALLED_APPS中。

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

2. 在您需要追踪历史的模型中添加history属性。

from simple_history.models import HistoricalRecords

class MyModel(models.Model):
    # ...
    history = HistoricalRecords()
    # ...

3. 运行迁移来创建历史记录所需的数据库表。

python manage.py migrate

现在，每当您对模型进行更改时，都会在相应的历史表中创建一个记录。

管理界面集成

django-simple-history还提供了一个管理界面，允许您查看和管理历史记录。

1. 在admin.py中注册您的模型。

from django.contrib import admin
from .models import MyModel

@admin.register(MyModel)
class MyModelAdmin(admin.ModelAdmin):
    list_display = ['name', 'history']

2. 访问Django管理界面，您将看到一个历史记录的按钮，可以查看和管理模型的历史记录。

3. 项目API使用文档

django-simple-history提供的API相对简单，主要涉及以下几个部分：

• HistoricalRecords: 一个用于追踪模型历史记录的 mixin。
• HistoricalModelAdmin: 用于Django admin中显示历史记录的ModelAdmin。

HistoricalRecords

在您想要跟踪历史的模型中添加HistoricalRecords。

class MyModel(models.Model):
    # ...
    history = HistoricalRecords()
    # ...

ModelAdmin Integration

通过继承HistoricalModelAdmin并在admin.py中注册，可以轻松在Django admin中集成历史记录。

from simple_history.admin import HistoricalModelAdmin
from .models import MyModel

@admin.register(MyModel)
class MyModelAdmin(HistoricalModelAdmin):
    # Your admin options here

4. 项目安装方式

如前所述，您可以通过pip安装或从源码安装django-simple-history。以下是简要步骤：

• 使用pip安装：

  pip install django-simple-history
  

• 从源码安装：

  git clone https://github.com/jazzband/django-simple-history.git
  cd django-simple-history
  pip install .
  

以上就是关于django-simple-history的安装和使用说明。希望对您有所帮助。