:mod:`rattail` Module
---------------------

.. automodule:: rattail

Attributes
==========

.. attribute:: __version__

   Rattail's version string.

.. attribute:: config

   :class:`RattailConfig` instance, global to the application.  After :func:`rattail.init()`
   is called, contains all settings read from config files.

Functions
=========

.. autofunction:: get_default_engine

.. autofunction:: get_uuid

.. autofunction:: init

.. autofunction:: reinit

.. autofunction:: require_extensions

.. autofunction:: set_default_engine

Classes
=======

.. note::

   The classes shown here are *always* available in the root ``rattail``
   namespace.  Most of the interesting classes though are not available there
   until after :func:`rattail.init()` is called; see that function for more
   info.

.. autoclass:: RattailConfig

.. autoclass:: Session
   :members:

   .. automethod:: __init__

.. autoclass:: FrameworkExtension
   :members:

   .. attribute:: schema

      Reference to a Python module containing a SQLAlchemy-Migrate repository.

   .. attribute:: enum

      Reference to a Python module containing enumeration values.

   .. attribute:: permissions

      Dictionary of grouped permission definitions.