``django-auditlog`` documentation
=================================

``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, including the user that changed
the models (later referred to as actor). Existing solutions seemed to offer a type of version control, which was not
needed and would cause too much overhead.

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 and also saves a summary of the changes in JSON format, so changes
can be tracked easily.

Contents
--------

.. toctree::
   :maxdepth: 2

   installation
   usage
   internals


Contribute to Auditlog
----------------------

If you found an issue with Auditlog or want to improve the code, please submit an issue and/or pull request via GitHub.
Before submitting a new issue, please make sure there is no issue submitted that involves the same issue.

GitHub repository: https://github.com/jjkester/django-auditlog

Issues: https://github.com/jjkester/django-auditlog/issues