Simple audit for model instances in Django.
Project description
This applications was created to audit model’s changes and maintain a log of them
Installation
You can install django-simple-audit in 2 ways: using pip or by setup.py install
$ pip install django-simple-audit
Then modify your settings.py, adding the package simple_audit in INSTALLED_APPS and in MIDDLEWARE_CLASSES add simple_audit.middleware.TrackingRequestOnThreadLocalMiddleware:
INSTALLED_APPS = [
'...',
'simple_audit',
]
MIDDLEWARE_CLASSES = [
'...',
'simple_audit.middleware.TrackingRequestOnThreadLocalMiddleware',
]
Usage
Tracking changes on a model
to audit a model you need import simple_audit and then register the model to be audited.
from django.db import models
import simple_audit
class Message(models.Model):
title = models.CharField(max_length=50, blank=False)
text = models.TextField(blank=False)
def __unicode__(self):
return self.text
class Owner(models.Model):
name = models.CharField(max_length=50, blank=False)
def __unicode__(self):
return self.name
class VirtualMachine(models.Model):
name = models.CharField(max_length=50, blank=False)
cpus = models.IntegerField()
owner = models.ForeignKey(Owner)
so = models.CharField(max_length=100, blank=False)
started = models.BooleanField()
def __unicode__(self):
return self.name
simple_audit.register(Message, Owner, VirtualMachine)
Advanced Usage (without httprequest or our middleware)
You can use django-simple-audit without an http request (for example in management command). In this situation there is no http request on thread context. To ensure gathering all modification on a single AuditRequest, you can specify it:
AuditRequest.new_request(path, user, ip)
try:
# my code... in same thread
finally:
AuditRequest.cleanup_request()
Tracking m2m fields changes
Tracking m2m fields changes is still experimental, but you can enable it with the following variable:
DJANGO_SIMPLE_AUDIT_M2M_FIELDS = True
You need to have at least one cache backend set in your django settings, otherwise the previous settings will be set to False.
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
'LOCATION': 'unique',
'TIMEOUT': 300,
}
}
Dependencies
Django >= 1.8
django.contrib.contenttypes installed in INSTALLED_APPS
TODO
Improve tests
CHANGELOG
- 0.2.2
Add support for Django 1.9.
- 0.2.1
Drop South, require Django 1.8 or newer.
- 0.2.0
Use South for migrations
- 0.1.12
Created some simple tests
Enable many to many fiedls tracking (see Usage)
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 Distribution
Built Distribution
Hashes for django-simple-audit-gizmag-0.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b393e395d7297d58f9553ff2d3e27d49ffa434b7886d338af5ef5b9df800f2f0 |
|
MD5 | b5c66d02d971ce4ae53dae36035a8d02 |
|
BLAKE2b-256 | 74b28ded1b20655794fd2f236fb7b1675733181982e9ef80dae0a6d5bbcaf74c |
Hashes for django_simple_audit_gizmag-0.2.2-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 119544e5b981a9580c8dbad86b3a1f22cf8ee5c8c16fdaffe604bd92167e5524 |
|
MD5 | 3576eb5b12a3d13267799c05d1f0bc0c |
|
BLAKE2b-256 | dc4865f99f1084228efad0b92998d05e48259de6ee84ebf41f39b4988a25d918 |