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.13.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd20c9bba87c2bfbf4f379b68b30c25aaabae7033fa30aa400b774ff6c9edf77 |
|
MD5 | 1db01656306cfb85e9393e81112298a0 |
|
BLAKE2b-256 | 2896d54b0eefd0acbf65df58f13eb7afdc2046be8089f874f8c0381b16339fd5 |
Hashes for django_audit_fields-0.3.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3784fc8dade860512b7d3af02a25ac8393f6127946ba5d2b5a21aecc0880ffc8 |
|
MD5 | 31fd545b55009e3f4935d33c26ee2206 |
|
BLAKE2b-256 | 004f14ab087cd85f720b5265f4cec27b55be10382cd15636880f0254a1eb01d0 |