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.5)
    13  # Project  : Official Cedar Backup Tools
    14  # Revision : $Id: __init__.py 998 2010-07-07 19:56:08Z pronovic $
    15  # Purpose  : Provides package initialization
    16  #
    17  # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
    18
    19  ########################################################################
    20  # Module documentation
    21  ########################################################################
    22
    23  """
    24  Official Cedar Backup Tools
    25
    26  This package provides official Cedar Backup tools.  Tools are things that feel
    27  a little like extensions, but don't fit the normal mold of extensions.  For
    28  instance, they might not be intended to run from cron, or might need to interact
    29  dynamically with the user (i.e. accept user input).
    30
    31  Tools are usually scripts that are run directly from the command line, just
    32  like the main C{cback} script.  Like the C{cback} script, the majority of a
    33  tool is implemented in a .py module, and then the script just invokes the
    34  module's C{cli()} function.  The actual scripts for tools are distributed in
    35  the util/ directory.
    36
    37  @author: Kenneth J. Pronovici <pronovic@ieee.org>
    38  """
    39
    40
    41  ########################################################################
    42  # Package initialization
    43  ########################################################################
    44
    45  # Using 'from CedarBackup2.tools import *' will just import the modules listed
    46  # in the __all__ variable.
    47
    48  __all__ = [ 'span', ]
    49