APFTask Python library
======================

.. module:: APFTask
.. moduleauthor:: Kyle Lanclos <lanclos@ucolick.org>


All task implementations use the functions defined in the APFTask module
to interact with the apftask service, whether they use the apftask command
line interface, or directly use the APFTask module. The latter is the
preferred approach for task implementations written in Python.


Task-agnostic functions
-----------------------

This group of functions can be used with any task, either as part of a
task's implementation, or to query other tasks.

.. autofunction:: Event
.. autofunction:: get
.. autofunction:: list
.. autofunction:: lookup
.. autofunction:: status
.. autofunction:: version


Functions to modify other tasks
-------------------------------

This group of functions performs operations on other tasks, as opposed to
being used internally as part of a task's implementation.

.. autofunction:: abort
.. autofunction:: pause
.. autofunction:: proceed


Functions used within a task
----------------------------

This group of functions is intended for use as part of a task's implementation.

.. autofunction:: call
.. autofunction:: do
.. autofunction:: establish
.. autofunction:: increment
.. autofunction:: message
.. autofunction:: phase
.. autofunction:: set
.. autofunction:: step
.. autofunction:: validate
.. autofunction:: wait
.. autofunction:: waitFor