A reusable Django app to log actions and display them in a timeline
This project uses django.db.models.JSONField
, and as such, you need:
- at least Django 3.2+
- a database supporting
django.db.models.JSONField
- A modern setuptools version
Install from PyPI by running
pip install django-timeline-logger
Add 'timeline_logger'
to your INSTALLED_APPS
.
Run the migrations:
python manage.py migrate
A custom template tag is provided to render the message of a log entry, for example:
{% extends "timeline_logger/base.html" %} {% load timeline %} {% block timeline %} <ul class="timeline__list col__22--vw"> {% for log in object_list %} <li class="timeline__entry"> {% render_message log in_view=True %} </li> {% endfor %} </ul> {% endblock timeline %}
This way, you can pass extra context to the template used for the log object.
The extended documentation is available on Read the Docs.