===================================
 Welcome to pyfai's documentation!
===================================

:Version: |version|

The pyfai Python library eases the implementation of FAI_ customization
scripts in Python, thus leveraging FAI's automation framework with
compact Python code with robust error handling.

.. _FAI: https://fai-project.org/

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   fai
   fai-env
   fai-subprocess
   fai-files


Key Features
============

* Access to most import `FAI variables`_.
* Wrapper for FAI tools such as fcopy_.
* Run commands in installation target (replacement for ``$ROOTCMD``).
* Access to common system tasks (e.g., create users).

.. _`FAI variables`: https://wiki.fai-project.org/index.php/Variables
.. _fcopy: https://fai-project.org/doc/man/fcopy.html


Installation
============

TODO


Indices and Tables
==================

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