Internals
=========

You might be interested in the way things work on the inside of Auditlog. This section covers the internal APIs of
Auditlog which is very useful when you are looking for more advanced ways to use the application or if you like to
contribute to the project.

The documentation below is automatically generated from the source code.

Models and fields
-----------------

.. automodule:: auditlog.models
    :members: LogEntry, LogEntryManager, AuditlogHistoryField

Middleware
----------

.. automodule:: auditlog.middleware
    :members: AuditlogMiddleware

Correlation ID
--------------

.. automodule:: auditlog.cid
    :members: get_cid, set_cid

Signal receivers
----------------

.. automodule:: auditlog.receivers
    :members:

Custom Signals
--------------
Django Auditlog provides two custom signals that will hook in before
and after any Auditlog record is written from a ``create``, ``update``,
``delete``, or ``accessed`` action on an audited model.

.. automodule:: auditlog.signals
    :members:
    :member-order: bysource

.. versionadded:: 3.0.0

Calculating changes
-------------------

.. automodule:: auditlog.diff
    :members:

Registry
--------

.. automodule:: auditlog.registry
    :members: