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

Rattail
=======

Welcome to the Rattail project.

The documentation you are currently reading is for the Rattail core Python
package.  Some additional information is available on the `website`_.  Clearly
not everything is documented yet.  Below you can see what has received some
attention thus far.

.. _website: https://rattailproject.org/

Narrative Documentation:

.. toctree::

   narr/email
   narr/filemon
   narr/batches

Package API:

.. toctree::
   :maxdepth: 1

   api/rattail
   api/rattail/csvutil
   api/rattail/db/batch
   api/rattail/db/batch.vendorcatalog
   api/rattail/db/batch.vendorinvoice
   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


Documentation To-Do
===================

.. todolist::


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

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