https://github.com/vvangelovski/django-audit-log

Audit log for your Django models
https://github.com/vvangelovski/django-audit-log

Last synced: 23 days ago
JSON representation

Audit log for your Django models

• Host: GitHub
• URL: https://github.com/vvangelovski/django-audit-log
• Owner: vvangelovski
• License: other
• Created: 2011-02-25T12:40:16.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2024-01-05T17:57:30.000Z (11 months ago)
• Last Synced: 2024-09-24T11:06:26.546Z (3 months ago)
• Language: Python
• Homepage:
• Size: 113 KB
• Stars: 232
• Watchers: 8
• Forks: 93
• Open Issues: 34
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt
  • Audit: audit_log/README.rst
  • Authors: AUTHORS.txt

Awesome Lists containing this project

• starred-awesome - django-audit-log - Audit log for your Django models (Python)

README

        
.. image:: https://readthedocs.org/projects/django-audit-log/badge/?version=latest

   :target: https://readthedocs.org/projects/django-audit-log/?badge=latest

   :alt: Documentation Status

.. image:: https://badges.gitter.im/Join Chat.svg

   :target: https://gitter.im/Atomidata/django-audit-log?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

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

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

    :alt: Latest Version

.. image:: https://img.shields.io/pypi/pyversions/django-audit-log.svg

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

    :alt: Supported Python versions

.. image:: https://img.shields.io/pypi/format/django-audit-log.svg

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

    :alt: Download format

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

django-audit-log

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

Tracking changes to django models.

* Model fields for keeping track of the user and session that created and modified a model instance.

* Abstract model class with fields ``created_by`` and ``modified_by`` fields.

* A model manager class that can automatically track changes made to a model in the database.

* Support for Django 1.6 and 1.7, South migrations, Django 1.7 migrations and custom User classes.

* Python 3 and 2.x support

`The documentation can be found here `_

**Tracking full model history on M2M relations is not supported yet.**

**Version 0.3.0 onwards is tested with Django 1.6. It should work with older versions of Django, but may break things unexpectedly!**

Quickstart Guide

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

Install it with pip from PyPi::

    pip install django-audit-log

Add ``audit_log.middleware.UserLoggingMiddleware`` to your ``MIDDLEWARE_CLASSES``::

    MIDDLEWARE_CLASSES = (

    'django.contrib.sessions.middleware.SessionMiddleware',

    'django.middleware.common.CommonMiddleware',

    'django.middleware.csrf.CsrfViewMiddleware',

    'django.contrib.auth.middleware.AuthenticationMiddleware',

    'django.contrib.messages.middleware.MessageMiddleware',

    'django.middleware.clickjacking.XFrameOptionsMiddleware',

    'audit_log.middleware.UserLoggingMiddleware',

    )

To just track who created or edited a model instance just make it inherit from ``AuthStampedModel``::

    from audit_log.models import AuthStampedModel

    class WarehouseEntry(AuthStampedModel):

        product = models.ForeignKey(Product)

        quantity = models.DecimalField(max_digits = 10, decimal_places = 2)

This will add 4 fields to the ``WarehouseEntry`` model:

* ``created_by`` - A foreign key to the user that created the model instance.

* ``created_with_session_key`` - Stores the session key with which the model instance was first created.

* ``modified_by`` - A foreign key to the user that last saved a model instance.

* ``modified_with_session_key`` - Stores the session key with which the model instance was last saved.

If you want to track full model change history you need to attach an ``AuditLog`` manager to the model::

    from django.db import models

    from audit_log.models.fields import LastUserField

    from audit_log.models.managers import AuditLog

    class ProductCategory(models.Model):

        name = models.CharField(max_length=150, primary_key = True)

        description = models.TextField()

        audit_log = AuditLog()

    class Product(models.Model):

        name = models.CharField(max_length = 150)

        description = models.TextField()

        price = models.DecimalField(max_digits = 10, decimal_places = 2)

        category = models.ForeignKey(ProductCategory)

        audit_log = AuditLog()

You can then query the audit log::

    In [2]: Product.audit_log.all()

    Out[2]: [,

            ,

            ,

            ,

            ,

            ]

`The documentation can be found here `_

*Note: This project was not maintained actively for a while. One of the reasons was that I wasn't receiving email notifications from GitHub. The other reason: We were using it just on a couple of projects that were frozen to old versions of Django. If you need any help with the project you can contact me by email directly if I don't respond to your GitHub issues. Feel free to nudge me over email if you have a patch for something. You can find my email in the AUTHORS file.*