Metadata-Version: 2.1
Name: tailer
Version: 0.4.1
Summary: Python tail is a simple implementation of GNU tail and head.
Home-page: http://github.com/six8/pytailer
Author: Mike Thornton
Author-email: six8@devdetails.com
License: MIT
Download-URL: http://github.com/six8/pytailer
Keywords: tail,head
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: POSIX
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Topic :: System :: Logging
Classifier: Topic :: Text Processing
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: System Shells
Classifier: Topic :: System :: Systems Administration
License-File: LICENSE

======
Tailer
======

.. image:: https://travis-ci.org/six8/pytailer.svg
    :target: https://travis-ci.org/six8/pytailer
    :alt: Build Status

Python tail is a simple implementation of GNU tail and head.

It provides 3 main functions that can be performed on any file-like object that supports ``seek()`` and ``tell()``.

* ``tail`` - read lines from the end of a file
* ``head`` - read lines from the top of a file
* ``follow`` - read lines as a file grows

It also comes with ``pytail``, a command line version offering the same functionality as GNU tail. This can be particularly useful on Windows systems that have no tail equivalent.

- `Tailer on GitHub <http://github.com/six8/pytailer>`_
- `Tailer on Pypi <http://pypi.python.org/pypi/tailer>`_

Installation
============

Install with ``pip`` or ``easy_install``.

::

    pip install tailer

Examples
========

::

  import tailer
  f = open('test.txt', 'w')
  for i in range(11):
      f.write('Line %d\\n' % (i + 1))
  f.close()

Tail
----
::

    # Get the last 3 lines of the file
    tailer.tail(open('test.txt'), 3)
    # ['Line 9', 'Line 10', 'Line 11']

Head
----
::

    # Get the first 3 lines of the file
    tailer.head(open('test.txt'), 3)
    # ['Line 1', 'Line 2', 'Line 3']

Follow
------
::

    # Follow the file as it grows
    for line in tailer.follow(open('test.txt')):
        print line

Running Tests
=============

Tailer currently only has doctests.

Run tests with nose::

    nosetests --with-doctest src/tailer

Run tests with doctest::

    python -m doctest -v src/tailer/__init__.py