###########
Python API
###########

FactoryTX includes a Python API that enables you to create custom FactoryTX
components. The easiest way to begin using the API is to take a look at the
walkthroughs in the :ref:`Tutorials` section. This assumes that you are familiar
with `Python 3 <https://docs.python.org/3/>`_ and common third-party libraries,
such as `Pandas <http://pandas.pydata.org/pandas-docs/stable/>`_.

This section serves to provide more details for a given module or class.


.. contents:: Modules
    :local:


=====================
factorytx.base module
=====================
.. include:: base_module.inc

====================================
factorytx.receivers.file module
====================================
.. include:: receivers.file.inc

====================================
factorytx.dataflow module
====================================
.. include:: dataflow.inc

====================================
factorytx.registry module
====================================
.. include:: registry.inc

====================================
factorytx.validation module
====================================
.. include:: validation.inc

====================================
factorytx.markers module
====================================
.. include:: markers.inc

====================================
factorytx.supervisor module
====================================
.. include:: supervisor.inc

====================================
factorytx.utils module
====================================
.. include:: utils.inc

====================================
factorytx.test_utils module
====================================
.. include:: test_utils.inc

====================================
factorytx.snapshot_test_utils module
====================================
.. include:: snapshot_test_utils.inc