yalp_grok 0.3

A Python library to parse strings and extract information from structured/unstructured data

YALP Grok
=========

|build-status| |coverage| |deps| |pypi|

.. |build-status| image:: http://img.shields.io/travis/yalp-log/yalp-grok/master.svg?style=flat
:alt: Build Status
:scale: 100%
:target: https://travis-ci.org/yalp-log/yalp-grok

.. |coverage| image:: http://img.shields.io/coveralls/yalp-log/yalp-grok.svg?style=flat
:alt: Coverage Status
:scale: 100%
:target: https://coveralls.io/r/yalp-log/yalp-grok?branch=master

.. |deps| image:: http://img.shields.io/gemnasium/yalp-log/yalp-grok.svg?style=flat
:alt: Dependency Status
:scale: 100%
:target: https://gemnasium.com/yalp-log/yalp-grok

.. |pypi| image:: http://img.shields.io/pypi/v/yalp_grok.svg?style=flat
:alt: PyPi version
:scale: 100%
:target: https://pypi.python.org/pypi/yalp_grok


Forked from https://github.com/garyelephant/pygrok as it seems to be dead. If
pygrok becomes active again this fork may be closed.

Python implementaion of Jordan Sissel's `Grok`.

Install
-------

.. code-block:: bash

pip install yalp_grok

Basic Usage
-----------

.. code-block:: python

>>> import yalp_grok as pygrok
>>> text = 'gary is male, 25 years old and weighs 68.5 kilograms'
>>> pattern = '%{WORD:name} is %{WORD:gender}, %{NUMBER:age} years old and
weighs %{NUMBER:weight} kilograms'
>>> print pygrok.grok_match(text, pattern)
{'gender': 'male', 'age': '25', 'name': 'gary', 'weight': '68.5'}

Reusing Patterns
----------------

Since compiling a pattern can be time consuming, patterns can be compiled once
and then reused for searching.

.. code-block:: python

>>> import yalp_grok as pygrok
>>> pattern = "%{COMMONAPACHELOG}"
>>> compiled_pattern = pygrok.compile_pattern(pattern)
>>> with open('/var/log/apache/access.log', 'r') as log_file
... matches = [pygrok.grok_search(line, compiled_pattern) for line in log_file]

.. _Grok: https://github.com/jordansissel/grok