libbe/__init__.py

   1 # Copyright (C) 2005-2010 Aaron Bentley and Panometrics, Inc.
   2 #                         W. Trevor King <wking@drexel.edu>
   3 #
   4 # This program is free software; you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation; either version 2 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along
  15 # with this program; if not, write to the Free Software Foundation, Inc.,
  16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17
  18 """The libbe module does all the legwork for bugs-everywhere_ (BE).
  19
  20 .. _bugs-everywhere: http://bugseverywhere.org
  21
  22 To facilitate faster loading, submodules are not imported by default.
  23 The available submodules are:
  24
  25 * :mod:`libbe.bugdir`
  26 * :mod:`libbe.bug`
  27 * :mod:`libbe.comment`
  28 * :mod:`libbe.command`
  29 * :mod:`libbe.diff`
  30 * :mod:`libbe.error`
  31 * :mod:`libbe.storage`
  32 * :mod:`libbe.ui`
  33 * :mod:`libbe.util`
  34 * :mod:`libbe.version`
  35 * :mod:`libbe._version`
  36 """
  37
  38 TESTING = False
  39 """Flag controlling test-suite generation.
  40
  41 To reduce module load time, test suite generation is turned of by
  42 default.  If you *do* want to generate the test suites, set
  43 ``TESTING=True`` before loading any :mod:`libbe` submodules.
  44
  45 Examples
  46 --------
  47
  48 >>> import libbe
  49 >>> libbe.TESTING = True
  50 >>> import libbe.bugdir
  51 >>> 'SimpleBugDir' in dir(libbe.bugdir)
  52 True
  53 """