2015-05-31 13:14:10 +00:00
|
|
|
django-auditlog documentation
|
|
|
|
|
=============================
|
2013-11-06 19:50:53 +00:00
|
|
|
|
2015-05-31 13:14:10 +00:00
|
|
|
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.
|
2013-12-12 16:57:29 +00:00
|
|
|
|
2015-10-19 14:09:01 +00:00
|
|
|
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.
|
2013-12-12 16:57:29 +00:00
|
|
|
|
2015-05-31 13:14:10 +00:00
|
|
|
The core idea of Auditlog is similar to the log from Django's admin. However, Auditlog is much more flexible than the
|
|
|
|
|
log from Django's admin app (:py:mod:`django.contrib.admin`). Also, Auditlog saves a summary of the changes in JSON
|
|
|
|
|
format, so changes can be tracked easily.
|
2013-12-12 16:57:29 +00:00
|
|
|
|
|
|
|
|
Contents
|
|
|
|
|
--------
|
2013-11-06 19:50:53 +00:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2013-12-12 16:57:29 +00:00
|
|
|
installation
|
|
|
|
|
usage
|
2023-08-13 09:38:21 +00:00
|
|
|
upgrade
|
2014-07-08 14:55:24 +00:00
|
|
|
internals
|
2013-11-06 19:50:53 +00:00
|
|
|
|
|
|
|
|
|
2013-12-12 16:57:29 +00:00
|
|
|
Contribute to Auditlog
|
|
|
|
|
----------------------
|
2013-11-06 19:50:53 +00:00
|
|
|
|
2015-10-19 14:09:01 +00:00
|
|
|
If you discovered a bug or want to improve the code, please submit an issue and/or pull request via GitHub.
|
2015-05-31 13:14:10 +00:00
|
|
|
Before submitting a new issue, please make sure there is no issue submitted that involves the same problem.
|
2013-11-06 19:50:53 +00:00
|
|
|
|
2020-10-23 10:16:27 +00:00
|
|
|
| GitHub repository: https://github.com/jazzband/django-auditlog
|
|
|
|
|
| Issues: https://github.com/jazzband/django-auditlog/issues
|
