Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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

Project description

pypi travis codecov downloads

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-audit-fields, version 0.1.13
Filename, size File type Python version Upload date Hashes
Filename, size django_audit_fields-0.1.13-py3-none-any.whl (21.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page