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:
.. 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
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 Distributions
Built Distribution
Hashes for django_audit_fields-0.3.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d06623b47fd6bd032c001d098548ab3091a72aabf108f53ac464ad3dd659758a |
|
MD5 | 9f7f0c877273e105dfff476024e13686 |
|
BLAKE2b-256 | 9d3983ec57b6665680ddecdf36da904466ade4292ec65acde2bf34508079c957 |