Skip to content

A reusable Django app to log actions and display them in a timeline πŸ“

License

Notifications You must be signed in to change notification settings

maykinmedia/django-timeline-logger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b602d9a Β· Feb 22, 2024
Feb 16, 2024
Feb 16, 2024
Feb 22, 2024
Jul 11, 2023
Feb 16, 2024
Feb 15, 2022
Feb 19, 2024
Feb 15, 2022
Feb 19, 2024
Jun 14, 2016
May 30, 2018
Jul 11, 2023
Feb 22, 2024
Feb 16, 2024

Repository files navigation

django-timeline-logger

A reusable Django app to log actions and display them in a timeline

Build status Code quality checks Coverage status black

python-versions django-versions pypi-version

Prerequisites

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

Installation

Install from PyPI by running

pip install django-timeline-logger

Add 'timeline_logger' to your INSTALLED_APPS.

Run the migrations:

python manage.py migrate

Usage in templates

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.

Documentation

The extended documentation is available on Read the Docs.

About

A reusable Django app to log actions and display them in a timeline πŸ“

Resources

License

Stars

Watchers

Forks

Packages

No packages published