Skip to main content

Generic event logger for Django models.

Project description

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

https://travis-ci.org/maykinmedia/django-timeline-logger.svg?branch=master https://codecov.io/gh/maykinmedia/django-timeline-logger/branch/develop/graph/badge.svg https://badge.fury.io/py/django-timeline-logger.svg

Prerequisites

This project uses django.contrib.postgres.JSONField, and as such, you need:

  • at least Django 1.11
  • at least PostgreSQL 9.4
  • at least psycopg2 2.5.4

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_timeline_logger-1.1.2-py2.py3-none-any.whl (18.2 kB) Copy SHA256 hash SHA256 Wheel 3.6
django-timeline-logger-1.1.2.tar.gz (10.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page