Metadata-Version: 1.1
Name: django-simple-log
Version: 0.0.5
Summary: Logging django models changes.
Home-page: https://github.com/kindlycat/django-simple-log/
Author: Grigory Mishchenko
Author-email: grishkokot@gmail.com
License: UNKNOWN
Description: Django simple log
        =================
        .. image:: https://travis-ci.org/kindlycat/django-simple-log.svg?branch=master
            :target: https://travis-ci.org/kindlycat/django-simple-log
        .. image:: https://coveralls.io/repos/github/kindlycat/django-simple-log/badge.svg?branch=master
            :target: https://coveralls.io/github/kindlycat/django-simple-log?branch=master
        .. image:: https://img.shields.io/pypi/v/django-simple-log.svg
            :target: https://pypi.python.org/pypi/django-simple-log
        .. image:: https://img.shields.io/pypi/status/django-simple-log.svg
            :target: https://pypi.python.org/pypi/django-simple-log
        .. image:: https://img.shields.io/pypi/pyversions/django-simple-log.svg
            :target: https://pypi.python.org/pypi/django-simple-log
        .. image:: https://img.shields.io/badge/django-1.9%2C%201.10-green.svg
            :target: https://pypi.python.org/pypi/django-simple-log
        
        Logging model changes on every create/update/delete. Working with django>=1.9
        (need JSONField).
        
        TL;DR
        -----
        Install using pip:
        
        .. code-block:: sh
        
            pip install django-simple-log
        
        Add to installed apps:
        
        .. code-block:: python
        
            INSTALLED_APPS = (
                ...
                'simple_log',
                ...
            )
        
        Add middleware for detecting user:
        
        .. code-block:: python
        
            MIDDLEWARE = [
                ...
                'simple_log.middleware.ThreadLocalMiddleware',
                ...
            ]
        
        Migrate:
        
        .. code-block:: sh
        
            python manage.py migrate
        
        
        Add to any __init__.py:
        
        .. code-block:: python
        
            import simple_log
        
            # For track all registered applications, including third-party
            simple_log.register()
            # Or for concrete model
            simple_log.register(Model)
            # Or multiple models
            simple_log.register(Model, AnotherModel)
        
        Settings
        ========
        
        SIMPLE_LOG_MODEL_LIST
        ---------------------
        
        Default: ``()``
        
        If set, than ``simple_log.register()`` register only models in the list.
        
        If you use ``simple_log.register(Model)``, this setting will be ignored.
        
        SIMPLE_LOG_EXCLUDE_MODEL_LIST
        -----------------------------
        
        Default: ``('admin.LogEntry', 'migrations.Migration', 'sessions.Session',
        'contenttypes.ContentType', 'captcha.CaptchaStore')``
        
        If set, than ``simple_log.register()`` register every model except in the list.
        
        If you use ``simple_log.register(Model)`` or ``SIMPLE_LOG_MODEL_LIST``, this
        setting will be ignored.
        
        SIMPLE_LOG_EXCLUDE_FIELD_LIST
        -----------------------------
        Default:
        ``('id', 'last_login', 'password', 'created_at', 'updated_at')``
        
        List of field names which not track.
        
        If you need to define which fields to track for concrete model, you can add
        one of the properties to model: ``simple_log_fields = ('id',)`` or
        ``simple_log_exclude_fields = ('password',)``.
        
        SIMPLE_LOG_ANONYMOUS_REPR
        -------------------------
        Default: ``'Anonymous'``
        
        User representation that write to log, if anonymous user changes model.
        
        
        SIMPLE_LOG_NONE_USER_REPR
        -------------------------
        Default: ``'System'``
        
        User representation that write to log, if user not detected (If middleware not
        working or if model changes from task or console).
        
        SIMPLE_LOG_MODEL
        ----------------
        Default: ``'simple_log.SimpleLog'``
        
        Model for writing logs. If you want to define your own model, you can
        inheritance from ``simple_log.SimpleLogAbstract`` and change this setting.
        
        SIMPLE_LOG_MODEL_SERIALIZER
        ---------------------------
        Default: ``'simple_log.models.ModelSerializer'``
        
        Class for serializing model fields to json.
        
        SIMPLE_LOG_GET_CURRENT_REQUEST
        ------------------------------
        Default: ``'simple_log.utils.get_current_request_default'``
        
        Function that return current request. Rewrite this setting if you already
        have middleware for storing current request.
        
Keywords: django log audit history
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: License :: OSI Approved :: BSD License
