CedarBackup3.actions.purge
==========================

.. py:module:: CedarBackup3.actions.purge

.. autoapi-nested-parse::

   Implements the standard 'purge' action.
   :author: Kenneth J. Pronovici <pronovic@ieee.org>







Module Contents
---------------

.. py:data:: logger

.. py:function:: executePurge(configPath, options, config)

   Executes the purge backup action.

   For each configured directory, we create a purge item list, remove from the
   list anything that's younger than the configured retain days value, and then
   purge from the filesystem what's left.

   :param configPath: Path to configuration file on disk
   :type configPath: String representing a path on disk
   :param options: Program command-line options
   :type options: Options object
   :param config: Program configuration
   :type config: Config object

   :raises ValueError: Under many generic error conditions


