libbe/storage/vcs/__init__.py

   1 # Copyright (C) 2009-2010 W. Trevor King <wking@drexel.edu>
   2 #
   3 # This program is free software; you can redistribute it and/or modify
   4 # it under the terms of the GNU General Public License as published by
   5 # the Free Software Foundation; either version 2 of the License, or
   6 # (at your option) any later version.
   7 #
   8 # This program is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 # GNU General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU General Public License along
  14 # with this program; if not, write to the Free Software Foundation, Inc.,
  15 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16
  17 """Define the Version Controlled System (VCS)-based
  18 :class:`~libbe.storage.base.Storage` and
  19 :class:`~libbe.storage.base.VersionedStorage` implementations.
  20
  21 There is a base class (:class:`~libbe.storage.vcs.VCS`) translating
  22 Storage language to VCS language, and a number of `VCS` implementations:
  23
  24 * :class:`~libbe.storage.vcs.arch.Arch`
  25 * :class:`~libbe.storage.vcs.bzr.Bzr`
  26 * :class:`~libbe.storage.vcs.darcs.Darcs`
  27 * :class:`~libbe.storage.vcs.git.Git`
  28 * :class:`~libbe.storage.vcs.hg.Hg`
  29
  30 The base `VCS` class also serves as a filesystem Storage backend (not
  31 versioning) in the event that a user has no VCS installed.
  32 """
  33
  34 import base
  35
  36 set_preferred_vcs = base.set_preferred_vcs
  37 vcs_by_name = base.vcs_by_name
  38 detect_vcs = base.detect_vcs
  39 installed_vcs = base.installed_vcs
  40
  41 __all__ = [set_preferred_vcs, vcs_by_name, detect_vcs, installed_vcs]