.. -*- coding: utf-8 -*-

Rattail
=======

Welcome to the Rattail project.

The documentation you are currently reading is for the Rattail core Python
package.  More information is (sort of) available at
http://rattailproject.org/.  Clearly not everything is documented yet.  Below
you can see what has received some attention thus far.

Narrative Documentation:

.. toctree::

   narr/email
   narr/filemon


Package API:

.. toctree::
   :maxdepth: 1

   api/rattail
   api/rattail/db/changes
   api/rattail/db/model
   api/rattail/db/util
   api/rattail/enum
   api/rattail/exceptions
   api/rattail/filemon/index
   api/rattail/filemon/actions
   api/rattail/filemon/config
   api/rattail/filemon/linux
   api/rattail/filemon/util
   api/rattail/filemon/win32
   api/rattail/files
   api/rattail/logging
   api/rattail/mail
   api/rattail/time


To-Do
=====

.. todolist::


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

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