mirror of
https://github.com/jazzband/django-auditlog.git
synced 2026-03-16 22:20:26 +00:00
31418d54f2
* Update repository references to Jazzband Issue #268 * Add Jazzband badge to README Issue #268 * Add Jazzband contribution guideline Issue #268
28 lines
1.2 KiB
ReStructuredText
28 lines
1.2 KiB
ReStructuredText
Installation
|
|
============
|
|
|
|
Installing Auditlog is simple and straightforward. First of all, you need a copy of Auditlog on your system. The easiest
|
|
way to do this is by using the Python Package Index (PyPI). Simply run the following command:
|
|
|
|
``pip install django-auditlog``
|
|
|
|
Instead of installing Auditlog via PyPI, you can also clone the Git repository or download the source code via GitHub.
|
|
The repository can be found at https://github.com/jazzband/django-auditlog/.
|
|
|
|
**Requirements**
|
|
|
|
- Python 3.5 or higher
|
|
- Django 2.2 or higher
|
|
|
|
Auditlog is currently tested with Python 3.5 - 3.8 and Django 2.2, 3.0 and 3.1. The latest test report can be found
|
|
at https://travis-ci.org/jazzband/django-auditlog.
|
|
|
|
Adding Auditlog to your Django application
|
|
------------------------------------------
|
|
|
|
To use Auditlog in your application, just add ``'auditlog'`` to your project's ``INSTALLED_APPS`` setting and run
|
|
``manage.py migrate`` to create/upgrade the necessary database structure.
|
|
|
|
If you want Auditlog to automatically set the actor for log entries you also need to enable the middleware by adding
|
|
``'auditlog.middleware.AuditlogMiddleware'`` to your ``MIDDLEWARE_CLASSES`` setting. Please check :doc:`usage` for more
|
|
information.
|