https://github.com/erikvw/django-audit-fields

Add model fields to track creation and modification dates, users and more on save.
https://github.com/erikvw/django-audit-fields

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/erikvw/django-audit-fields
• Owner: erikvw
• License: gpl-3.0
• Created: 2019-03-03T18:49:58.000Z (almost 6 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-05T15:03:54.000Z (9 months ago)
• Last Synced: 2024-09-14T22:24:13.542Z (4 months ago)
• Language: Python
• Size: 91.8 KB
• Stars: 6
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

README

        
|pypi| |actions| |codecov| |downloads|

django-audit-fields

-------------------

VERSION

=======

* <=0.3.3 (DJ 3.1, py 3.7, 3.8)

* >=0.3.4 (DJ 3.2+, py 3.9+)

* >=0.3.14 (DJ4.2, py3.11) includes locale

Installation

============

.. code-block:: bash

    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``

.. code-block:: python

    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``

.. code-block:: python

    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``:

.. code-block:: python

    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

.. |pypi| image:: https://img.shields.io/pypi/v/django-audit-fields.svg

    :target: https://pypi.python.org/pypi/django-audit-fields

.. |codecov| image:: https://codecov.io/gh/erikvw/django-audit-fields/branch/develop/graph/badge.svg

  :target: https://codecov.io/gh/erikvw/django-audit-fields

.. |downloads| image:: https://pepy.tech/badge/django-audit-fields

   :target: https://pepy.tech/project/django-audit-fields

.. |actions| image:: https://github.com/erikvw/django-audit-fields/actions/workflows/build.yml/badge.svg

  :target: https://github.com/erikvw/django-audit-fields/actions/workflows/build.yml