libbe/storage/vcs/__init__.py

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