imgcreate/__init__.py

   1 #
   2 # imgcreate : Support for creating system images, including Live CDs
   3 #
   4 # Copyright 2007, Red Hat  Inc.
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; version 2 of the License.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU Library General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18
  19 from imgcreate.live import *
  20 from imgcreate.creator import *
  21 from imgcreate.yuminst import *
  22 from imgcreate.kickstart import *
  23 from imgcreate.fs import *
  24 from imgcreate.debug import *
  25
  26 """A set of classes for building Fedora system images.
  27
  28 The following image creators are available:
  29   - ImageCreator - installs to a directory
  30   - LoopImageCreator - installs to an ext3 image
  31   - LiveImageCreator - installs to a bootable ISO
  32
  33 Also exported are:
  34   - CreatorError - all exceptions throw are of this type
  35   - FSLABEL_MAXLEN - the length to which LoopImageCreator.fslabel is truncated
  36   - read_kickstart() - a utility function for kickstart parsing
  37   - build_name() - a utility to construct an image name
  38
  39 Each of the creator classes are designed to be subclassable, allowing the user
  40 to create new creator subclasses in order to support the building other types
  41 of system images.
  42
  43 The subclassing API consists of:
  44
  45   1) Attributes available to subclasses, e.g. ImageCreator._instroot
  46
  47   2) Hooks - methods which may be overridden by subclasses, e.g.
  48      ImageCreator._mount_instroot()
  49
  50   3) Helpers - methods which may be used by subclasses in order to implement
  51      hooks, e.g. ImageCreator._chroot()
  52
  53 Overriding public methods (e.g. ImageCreator.package()) or subclassing helpers
  54 is not supported and is not guaranteed to continue working as expect in the
  55 future.
  56
  57 """
  58
  59 __all__ = (
  60     'CreatorError',
  61     'ImageCreator',
  62     'LiveImageCreator',
  63     'LoopImageCreator',
  64     'FSLABEL_MAXLEN',
  65     'read_kickstart',
  66     'construct_name',
  67     'setup_logging',
  68 )