Django Easy Audit 使用教程

Django Easy Audit 使用教程

django-easy-auditYet another Django audit log app, hopefully the simplest one.项目地址:https://gitcode.com/gh_mirrors/dj/django-easy-audit

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

Django Easy Audit 项目的目录结构如下：

django-easy-audit/
├── easyaudit/
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── middleware.py
│   ├── models.py
│   ├── settings.py
│   ├── signals.py
│   ├── urls.py
│   └── views.py
├── manage.py
├── README.md
├── setup.py
└── tests/

目录结构介绍

• easyaudit/: 包含 Django Easy Audit 应用的核心文件。
  • __init__.py: 初始化文件，使该目录成为一个 Python 包。
  • admin.py: 定义 Django 管理界面的配置。
  • apps.py: 应用的配置文件。
  • middleware.py: 中间件文件，用于处理请求和响应。
  • models.py: 定义审计日志的数据模型。
  • settings.py: 应用的配置设置。
  • signals.py: 信号处理文件，用于捕获模型事件。
  • urls.py: URL 路由配置。
  • views.py: 视图文件，处理 HTTP 请求。
• manage.py: Django 项目的管理脚本。
• README.md: 项目说明文档。
• setup.py: 用于安装项目的脚本。
• tests/: 包含项目的测试文件。

2. 项目的启动文件介绍

Django Easy Audit 项目的启动文件是 manage.py。这个文件是 Django 项目的标准管理脚本，用于执行各种管理任务，如运行开发服务器、迁移数据库等。

使用方法

python manage.py runserver  # 启动开发服务器
python manage.py migrate    # 执行数据库迁移

3. 项目的配置文件介绍

Django Easy Audit 的配置文件主要位于 easyaudit/settings.py 中。以下是一些重要的配置项：

配置项介绍

• DJANGO_EASY_AUDIT_WATCH_MODEL_EVENTS: 是否记录模型事件。
• DJANGO_EASY_AUDIT_WATCH_AUTH_EVENTS: 是否记录认证事件。
• DJANGO_EASY_AUDIT_WATCH_REQUEST_EVENTS: 是否记录请求事件。
• DJANGO_EASY_AUDIT_UNREGISTERED_CLASSES_EXTRA: 忽略的模型列表。
• DJANGO_EASY_AUDIT_UNREGISTERED_URLS_EXTRA: 忽略的 URL 列表。
• DJANGO_EASY_AUDIT_CRUD_DIFFERENCE_CALLBACKS: 自定义回调函数列表。

示例配置

# settings.py

DJANGO_EASY_AUDIT_WATCH_MODEL_EVENTS = True
DJANGO_EASY_AUDIT_WATCH_AUTH_EVENTS = True
DJANGO_EASY_AUDIT_WATCH_REQUEST_EVENTS = True
DJANGO_EASY_AUDIT_UNREGISTERED_CLASSES_EXTRA = ['myapp.MyModel']
DJANGO_EASY_AUDIT_UNREGISTERED_URLS_EXTRA = [r'^/admin/']
DJANGO_EASY_AUDIT_CRUD_DIFFERENCE_CALLBACKS = []

通过这些配置项，可以灵活地控制 Django Easy Audit 的日志记录行为。

django-easy-auditYet another Django audit log app, hopefully the simplest one.项目地址:https://gitcode.com/gh_mirrors/dj/django-easy-audit