Add model fields to track creation and modification dates, users and more on save.
Project description
django-audit-fields
VERSION
<=0.3.3 (DJ 3.1, py 3.7, 3.8)
>=0.3.4 (DJ 3.2+, py 3.9+)
Installation
pip install django_audit_fields
Add both django_audit_fields and django_revision to INSTALLED_APPS
INSTALLED_APPS = [
"...",
"django_revision.apps.AppConfig",
"django_audit_fields.apps.AppConfig",
"..."]
Usage
Add model fields to track creation and modification dates, users and more on save.
Declare your model using AuditModelMixin
from django_audit_fields.model_mixins import AuditModelMixin
class MyModel(AuditModelMixin, models.Model):
...
class Meta(AuditModelMixin.Meta):
pass
Preferably, use a UUID as primary key by declaring your model using AuditUuidModelMixin
from django_audit_fields.model_mixins import AuditUuidModelMixin
class MyModel(AuditUuidModelMixin, models.Model):
...
class Meta(AuditUuidModelMixin.Meta)
pass
The model mixins AuditModelMixin and AuditUuidModelMixin:
add audit fields (created, modified, user_created, user_modified, hostname_created, hostname_modified);
The model mixin AuditUuidModelMixin also
sets the id fields to a UUIDField instead of an integer;
Most models require an audit trail. If so, add the HistoricalRecord model manager from django-simple-history:
from simple_history.models import HistoricalRecords
class MyModel(AuditUuidModelMixin, models.Model):
...
history = HistoricalRecords()
Notes
User created and modified fields behave as follows:
created is only set on pre-save add
modified is always updated
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-audit-fields-0.3.12.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52a3a57e7c725ae815a0517a16a239fb1d0851435042b214f3993d9a2f4f9002 |
|
MD5 | c946ae91abc7e3ef5e515201f3024963 |
|
BLAKE2b-256 | 4c2a5dc2a5d1d149a95fbdedd3287a97acf44f7278f413091086523370f77e2a |
Hashes for django_audit_fields-0.3.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7287ea4c285bd57bea6ab249bf5653ffcbf3c63b333538424b0e1204780a2e0 |
|
MD5 | dede16765c1873faba3d0b3c4275a2c8 |
|
BLAKE2b-256 | cc4519e4a20ce96fdfb4bee38e98f3d1328054e384157ae2e0fb0213faad6811 |