django-audit-fields 0.1.14

Add model fields to track creation and modification dates, users and more on save.

django-audit-fields

Installation

pip install django_audit_fields

Add both django_audit_fields and django_revision to INSTALLED_APPS:

.. code-block:: python

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 HistoricalRecord

class MyModel(AuditUuidModelMixin, models.Model):

    ...
    history = HistoricalRecord()

Notes

User created and modified fields behave as follows:

• created is only set on pre-save add

• modified is always updated