django-eventlog


Namedjango-eventlog JSON
Version 1.0 PyPI version JSON
download
home_pagehttps://github.com/bartTC/django-eventlog/
Summarydjango-eventlog stores event messages in a Django model.
upload_time2018-02-13 14:11:02
maintainer
docs_urlNone
authorMartin Mahner
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage
            .. image:: https://travis-ci.org/bartTC/django-eventlog.svg?branch=master
    :target: https://travis-ci.org/bartTC/django-eventlog

.. image:: https://codecov.io/github/bartTC/django-eventlog/coverage.svg?branch=master
    :target: https://codecov.io/github/bartTC/django-eventlog?branch=master

Full documentation: https://django-eventlog.readthedocs.io/en/latest/

===============
django-eventlog
===============

django-eventlog is a very simple event logger you can use to track certain
actions in your code. Events are stored in a Django model and can be viewed
in the Django Admin.

Usage Example::

    from eventlog import EventGroup

    e = EventGroup()                       # Start a new Event Group
    e.info('About to send 1000 mails.',    # Trigger an Event
           initiator='Mailer Daemon')
    try:
        # ... sending 1000 mails
        e.info('All emails sent!',         # Trigger an Event in the same group,
               initiator='Mailer Daemon')  # so they are combined in the admin.
    except Exception:
        e.error('There was an error sending the emails.',
                initiator='Mailer Daemon')


Events can be grouped in a "Event Group" and when hovering over one item
in the admin, all events of the same group are highlighted:

.. image:: https://github.com/bartTC/django-eventlog/raw/master/docs/_static/change_list.png
   :scale: 100 %

The details view of an event will list all other events of this group so you
can track the progress:

.. image:: https://github.com/bartTC/django-eventlog/raw/master/docs/_static/change_form.png
   :scale: 100 %

.. note::

  While looking similar, it's not intended to be a replacement for your
  regular Python ``logging`` facility, rather an addition to it.

  django-eventlog stores it's data in a regular database model, so each log entry
  will trigger a SQL Insert. Therefore you should be careful using it in high
  performance and/or high volume environments.


=========
Changelog
=========

1.0 (2018-02-13)
================

- Production ready 1.0 release.
- The details Admin view now displays all events of the group with an
  annotated delay, so you can see the progress of the group.

0.9 (2018-02-13)
================

- Initial release.
- Django 1.8 to 2.0 compatibility.
- Python 2.7 to 3.6 compatibility.




            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "", 
    "upload_time": "2018-02-13 14:11:02", 
    "author": "Martin Mahner", 
    "home_page": "https://github.com/bartTC/django-eventlog/", 
    "github_user": "bartTC", 
    "download_url": "https://pypi.python.org/packages/31/0f/b7aff2ece6d78433d8df0c789cd82c3dd43c8ff9d045bdd8caec943562f2/django-eventlog-1.0.tar.gz", 
    "platform": "", 
    "version": "1.0", 
    "cheesecake_documentation_id": null, 
    "description": ".. image:: https://travis-ci.org/bartTC/django-eventlog.svg?branch=master\n    :target: https://travis-ci.org/bartTC/django-eventlog\n\n.. image:: https://codecov.io/github/bartTC/django-eventlog/coverage.svg?branch=master\n    :target: https://codecov.io/github/bartTC/django-eventlog?branch=master\n\nFull documentation: https://django-eventlog.readthedocs.io/en/latest/\n\n===============\ndjango-eventlog\n===============\n\ndjango-eventlog is a very simple event logger you can use to track certain\nactions in your code. Events are stored in a Django model and can be viewed\nin the Django Admin.\n\nUsage Example::\n\n    from eventlog import EventGroup\n\n    e = EventGroup()                       # Start a new Event Group\n    e.info('About to send 1000 mails.',    # Trigger an Event\n           initiator='Mailer Daemon')\n    try:\n        # ... sending 1000 mails\n        e.info('All emails sent!',         # Trigger an Event in the same group,\n               initiator='Mailer Daemon')  # so they are combined in the admin.\n    except Exception:\n        e.error('There was an error sending the emails.',\n                initiator='Mailer Daemon')\n\n\nEvents can be grouped in a \"Event Group\" and when hovering over one item\nin the admin, all events of the same group are highlighted:\n\n.. image:: https://github.com/bartTC/django-eventlog/raw/master/docs/_static/change_list.png\n   :scale: 100 %\n\nThe details view of an event will list all other events of this group so you\ncan track the progress:\n\n.. image:: https://github.com/bartTC/django-eventlog/raw/master/docs/_static/change_form.png\n   :scale: 100 %\n\n.. note::\n\n  While looking similar, it's not intended to be a replacement for your\n  regular Python ``logging`` facility, rather an addition to it.\n\n  django-eventlog stores it's data in a regular database model, so each log entry\n  will trigger a SQL Insert. Therefore you should be careful using it in high\n  performance and/or high volume environments.\n\n\n=========\nChangelog\n=========\n\n1.0 (2018-02-13)\n================\n\n- Production ready 1.0 release.\n- The details Admin view now displays all events of the group with an\n  annotated delay, so you can see the progress of the group.\n\n0.9 (2018-02-13)\n================\n\n- Initial release.\n- Django 1.8 to 2.0 compatibility.\n- Python 2.7 to 3.6 compatibility.\n\n\n\n", 
    "tox": true, 
    "lcname": "django-eventlog", 
    "bugtrack_url": null, 
    "github": true, 
    "coveralls": true, 
    "name": "django-eventlog", 
    "license": "", 
    "travis_ci": true, 
    "github_project": "django-eventlog", 
    "summary": "django-eventlog stores event messages in a Django model.", 
    "split_keywords": [], 
    "author_email": "martin@mahner.org", 
    "urls": [
        {
            "has_sig": true, 
            "upload_time": "2018-02-13T14:11:02", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/31/0f/b7aff2ece6d78433d8df0c789cd82c3dd43c8ff9d045bdd8caec943562f2/django-eventlog-1.0.tar.gz", 
            "md5_digest": "4d4d7cf1636c38e07817b0423bd96ccd", 
            "downloads": 0, 
            "filename": "django-eventlog-1.0.tar.gz", 
            "packagetype": "sdist", 
            "path": "31/0f/b7aff2ece6d78433d8df0c789cd82c3dd43c8ff9d045bdd8caec943562f2/django-eventlog-1.0.tar.gz", 
            "size": 1169336
        }, 
        {
            "has_sig": true, 
            "upload_time": "2018-02-13T14:10:55", 
            "comment_text": "", 
            "python_version": "py2.py3", 
            "url": "https://pypi.python.org/packages/b9/12/3d03b75b0577d82da9e0f000248d77890ef931216fcd7190e044a4bda787/django_eventlog-1.0-py2.py3-none-any.whl", 
            "md5_digest": "b1729e1d3e070a6ae4d292811646e460", 
            "downloads": 0, 
            "filename": "django_eventlog-1.0-py2.py3-none-any.whl", 
            "packagetype": "bdist_wheel", 
            "path": "b9/12/3d03b75b0577d82da9e0f000248d77890ef931216fcd7190e044a4bda787/django_eventlog-1.0-py2.py3-none-any.whl", 
            "size": 14719
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}