=============
API Reference
=============

The reference section contains documentation of Passlib's public API.
These chapters are focused on providing detailed reference of the individual
functions and classes; they will generally be cross-linked to any related walkthrough
documentation (which tries to provide a higher-level synthetic view).

.. rst-class:: float-right without-title

.. note::

    **Primary modules:**

    The primary modules that will be of interest are:

    * :mod:`passlib.hash`
    * :mod:`passlib.context`
    * :mod:`passlib.totp`
    * :mod:`passlib.exc`

.. rst-class:: float-right without-title clear-right

.. caution::

    **Internal modules:**

    The following modules are mainly used internally,
    may change structure between releases,
    and are documented mainly for completeness:

    * :mod:`passlib.crypto`
    * :mod:`passlib.registry`
    * :mod:`passlib.utils`

**Alphabetical module list:**

.. toctree::
    :titlesonly:
    :maxdepth: 1

    passlib.apache
    passlib.apps
    passlib.context
    passlib.crypto
    passlib.exc
    passlib.ext.django
    passlib.hash
    passlib.hosts
    passlib.ifc
    passlib.pwd
    passlib.registry
    passlib.totp
    passlib.utils
