Metadata-Version: 2.0
Name: syslogmp
Version: 0.2.2
Summary: A parser for BSD syslog protocol (RFC 3164) messages
Home-page: http://homework.nwsnet.de/releases/76d6/#syslogmp
Author: Jochen Kupperschmidt
Author-email: homework@nwsnet.de
License: MIT
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Communications
Classifier: Topic :: Internet
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Topic :: System :: Systems Administration

syslogmp
========

A parser for BSD syslog protocol (RFC 3164) messages

This library was extracted from syslog2IRC_.


Requirements
------------

- Python 2.7+ or 3.3+
- enum34_ (on Python versions before 3.4)


Installation
------------

Install this package via pip_:

.. code:: sh

    $ pip install syslogmp

On Python versions before 3.4, the enum34_ package should be installed
automatically.


Usage
-----

To parse a syslog message:

.. code:: python

    from syslogmp import parse

    # Parse data (usually received via network).
    message = parse(data)

    # Let's see what we've got here.
    print(message.facility)
    print(message.facility.description)
    print(message.severity)
    print(message.timestamp)
    print(message.hostname)
    print(message.message)


Further Reading
---------------

For more information, see `RFC 3164`_, "The BSD syslog Protocol".

Please note that there is `RFC 5424`_, "The Syslog Protocol", which
obsoletes `RFC 3164`_. This package, however, only implements the
latter.


.. _syslog2IRC: http://homework.nwsnet.de/releases/c474/#syslog2irc
.. _enum34:     https://pypi.python.org/pypi/enum34
.. _pip:        http://www.pip-installer.org/
.. _RFC 3164:   http://tools.ietf.org/html/rfc3164
.. _RFC 5424:   http://tools.ietf.org/html/rfc5424


:Copyright: 2007-2016 Jochen Kupperschmidt
:Date: 01-Mar-2016
:License: MIT, see LICENSE for details.
:Version: 0.2.2


