roundup/__init__.py

   1 #
   2 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
   3 # This module is free software, and you may redistribute it and/or modify
   4 # under the same terms as Python, so long as this copyright message and
   5 # disclaimer are retained in their original form.
   6 #
   7 # IN NO EVENT SHALL THE BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
   8 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
   9 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
  10 # POSSIBILITY OF SUCH DAMAGE.
  11 #
  12 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  14 # FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
  15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
  16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  17 #
  18 # $Id: __init__.py,v 1.5 2001-08-07 00:15:51 richard Exp $
  19
  20 __doc__ = '''
  21 This is a simple-to-use and -install issue-tracking system with
  22 command-line, web and e-mail interfaces.
  23
  24 Roundup manages a number of issues (with properties such as
  25 "description", "priority", and so on) and provides the ability to (a) submit
  26 new issues, (b) find and edit existing issues, and (c) discuss issues with
  27 other participants. The system will facilitate communication among the
  28 participants by managing discussions and notifying interested parties when
  29 issues are edited.
  30
  31 Roundup's structure is that of a cake:
  32
  33  _________________________________________________________________________
  34 |  E-mail Client   |   Web Browser   |   Detector Scripts   |    Shell    |
  35 |------------------+-----------------+----------------------+-------------|
  36 |   E-mail User    |    Web User     |      Detector        |   Command   |
  37 |-------------------------------------------------------------------------|
  38 |                         Roundup Database Layer                          |
  39 |-------------------------------------------------------------------------|
  40 |                          Hyperdatabase Layer                            |
  41 |-------------------------------------------------------------------------|
  42 |                             Storage Layer                               |
  43  -------------------------------------------------------------------------
  44
  45 The first layer represents the users (chocolate).
  46 The second layer is the Roundup interface to the users (vanilla).
  47 The third and fourth layers are the internal Roundup database storage
  48   mechanisms (strawberry).
  49 The final, lowest layer is the underlying database storage (rum).
  50
  51 These are implemented in the code in the following manner:
  52   E-mail User: roundup-mailgw and roundup.mailgw
  53      Web User: cgi-bin/roundup.cgi or roundup-server over
  54                roundup.cgi_client, roundup.cgitb and roundup.htmltemplate
  55      Detector: roundup.roundupdb and templates/<template>/detectors
  56       Command: roundup-admin
  57    Roundup DB: roundup.roundupdb
  58      Hyper DB: roundup.hyperdb, roundup.date
  59       Storage: roundup.backends.*
  60
  61 Additionally, there is a directory of unit tests in "test".
  62
  63 For more information, see the original overview and specification documents
  64 written by Ka-Ping Yee in the "doc" directory. If nothing else, it has a
  65 much prettier cake :)
  66 '''
  67
  68 #
  69 # $Log: not supported by cvs2svn $
  70 # Revision 1.4  2001/07/29 07:01:39  richard
  71 # Added vim command to all source so that we don't get no steenkin' tabs :)
  72 #
  73 # Revision 1.3  2001/07/28 01:39:02  richard
  74 # Added some documentation to the roundup package.
  75 #
  76 # Revision 1.2  2001/07/22 12:09:32  richard
  77 # Final commit of Grande Splite
  78 #
  79 #
  80 # vim: set filetype=python ts=4 sw=4 et si