.. ulif.loghandlers documentation master file, created by
   sphinx-quickstart on Mon May 21 13:27:37 2012.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

ulif.loghandlers
================

*Additional logging handlers*

Downloads available at http://pypi.python.org/pypi/ulif.loghandlers/#downloads

.. include:: ../../README.txt

API
===

.. autoclass:: ulif.loghandlers.DatedRotatingFileHandler

   .. automethod:: ulif.loghandlers.DatedRotatingFileHandler.doRollover

   .. automethod:: ulif.loghandlers.DatedRotatingFileHandler.emit

For Developers
==============

The complete sources are available via SVN from
https://svn.gnufix.de/repos/main/ulif.loghandlers.

You can get a copy of the trunk with::

$ svn co https://svn.gnufix.de/repos/main/ulif.loghandlers/trunk

As this package is based on zc.buildout_, you might want to build the
development environment first.

Change to the checked out directory and do::

  $ python bootstrap.py

This will create local files needed for running `buildout`. This step
is normally needed only once.::

  $ ./bin/buildout

will then do the heavy stuff: fetch needed packages, install the
testrunner and documentation generation scripts, etc.

You normally only have to rerun `buildout` only after changes to
`setup.py` or `buildout.cfg`.

:mod:`ulif.loghandlers` tests are based on py.test_. The needed test
script should be generated by `buildout` automatically. You can run
the tests entering::

  $ ./bin/py.test

Releases of :mod:`ulif.loghandlers` should provide a test coverage of
100%. If you intend to send a patch, please also provide tests for
your changes and check the test coverage with::

  $ ./bin/py.test --cov src/ulif/loghandlers

The documentation can be built doing::

  $ ./bin/sphinx-build docs/source docs/build/html

and can be found as HTML in `docs/build/html/` afterwards.



Changes
=======

.. include:: ../../CHANGES.txt

Copyright
=========

.. include:: ../../COPYRIGHT.txt

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. _zc.buildout: http://pypi.python.org/pypi/zc.buildout
.. _py.test: http://pytest.org/