Please remember that this app is still in development. Test this app before deploying it in production environments.
django-auditlog (Auditlog) is a reusable app for Django that makes logging object changes a breeze. Auditlog tries to use as much as Python and Django’s built in functionality to keep the list of dependencies as short as possible. Also, Auditlog aims to be fast and simple to use.
Auditlog is created out of the need for a simple Django app that logs changes to models along with the user who made the changes (later referred to as actor). Existing solutions seemed to offer a type of version control, which was found excessive and expensive in terms of database storage and performance.
The core idea of Auditlog is similar to the log from Django’s admin. Unlike the log from Django’s admin (django.contrib.admin) Auditlog is much more flexible. Also, Auditlog saves a summary of the changes in JSON format, so changes can be tracked easily.
The documentation for django-auditlog can be found on http://django-auditlog.readthedocs.org. The source files are available in the docs folder.
Auditlog is licensed under the MIT license (see the LICENSE file for details).
If you have great ideas for Auditlog, or if you like to improve something, feel free to fork this repository and/or create a pull request. I'm open for suggestions. If you like to discuss something with me (about Auditlog), please open an issue.
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and update relevant documentation.
- The pull request should work for Python 2.7, 3.4+, and with Django>=1.8. Check https://travis-ci.org/jjkester/django-auditlog/pull_requests and make sure that the tests pass for all supported Python versions.