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.14.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72b214993e833a2d544c8d7aa6792c833da533de977a58b44348300452e170a9 |
|
MD5 | 1765084c0bbeba00c4ce0ccfc929e377 |
|
BLAKE2b-256 | 8f5a51a7fb50b2ded04825ad99bf59367ef74fa73164e449dfaa646a54d5b415 |
Hashes for django_audit_fields-0.3.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c28b288e0693dc0cdc9593011a68875fb57495a43da4738119ae54a8e73eaed |
|
MD5 | 74d88e7f68e3a50c3feca580402dd6b0 |
|
BLAKE2b-256 | b7206ffd42fa2ea32dc96c715fe4e474ea5e553e1ec5656628c83eede5e34689 |