CedarBackup2.tools

Package CedarBackup2 :: Package tools |
[hide private]
[frames] | no frames]

# Source Code for Package CedarBackup2.tools

     1  # -*- coding: iso-8859-1 -*-
     2  # vim: set ft=python ts=3 sw=3 expandtab:
     3  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
     4  #
     5  #              C E D A R
     6  #          S O L U T I O N S       "Software done right."
     7  #           S O F T W A R E
     8  #
     9  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
    10  #
    11  # Author   : Kenneth J. Pronovici <pronovic@ieee.org>
    12  # Language : Python 2 (>= 2.7)
    13  # Project  : Official Cedar Backup Tools
    14  # Purpose  : Provides package initialization
    15  #
    16  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
    17
    18  ########################################################################
    19  # Module documentation
    20  ########################################################################
    21
    22  """
    23  Official Cedar Backup Tools
    24
    25  This package provides official Cedar Backup tools.  Tools are things that feel
    26  a little like extensions, but don't fit the normal mold of extensions.  For
    27  instance, they might not be intended to run from cron, or might need to interact
    28  dynamically with the user (i.e. accept user input).
    29
    30  Tools are usually scripts that are run directly from the command line, just
    31  like the main C{cback} script.  Like the C{cback} script, the majority of a
    32  tool is implemented in a .py module, and then the script just invokes the
    33  module's C{cli()} function.  The actual scripts for tools are distributed in
    34  the util/ directory.
    35
    36  @author: Kenneth J. Pronovici <pronovic@ieee.org>
    37  """
    38
    39
    40  ########################################################################
    41  # Package initialization
    42  ########################################################################
    43
    44  # Using 'from CedarBackup2.tools import *' will just import the modules listed
    45  # in the __all__ variable.
    46
    47  __all__ = [ 'span', 'amazons3', ]
    48