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 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.14 2002-10-03 06:56:28 richard Exp $
  19
  20 ''' Roundup - issue tracking for knowledge workers.
  21
  22 This is a simple-to-use and -install issue-tracking system with
  23 command-line, web and e-mail interfaces.
  24
  25 Roundup manages a number of issues (with properties such as
  26 "description", "priority", and so on) and provides the ability to (a) submit
  27 new issues, (b) find and edit existing issues, and (c) discuss issues with
  28 other participants. The system will facilitate communication among the
  29 participants by managing discussions and notifying interested parties when
  30 issues are edited.
  31
  32 Roundup's structure is that of a cake::
  33
  34   _________________________________________________________________________
  35  |  E-mail Client   |   Web Browser   |   Detector Scripts   |    Shell    |
  36  |------------------+-----------------+----------------------+-------------|
  37  |   E-mail User    |    Web User     |      Detector        |   Command   |
  38  |-------------------------------------------------------------------------|
  39  |                         Roundup Database Layer                          |
  40  |-------------------------------------------------------------------------|
  41  |                          Hyperdatabase Layer                            |
  42  |-------------------------------------------------------------------------|
  43  |                             Storage Layer                               |
  44   -------------------------------------------------------------------------
  45
  46 The first layer represents the users (chocolate).
  47 The second layer is the Roundup interface to the users (vanilla).
  48 The third and fourth layers are the internal Roundup database storage
  49   mechanisms (strawberry).
  50 The final, lowest layer is the underlying database storage (rum).
  51
  52 These are implemented in the code in the following manner::
  53
  54   E-mail User: roundup-mailgw and roundup.mailgw
  55      Web User: cgi-bin/roundup.cgi or roundup-server over
  56                roundup.cgi.client and roundup.cgi.template
  57      Detector: roundup.roundupdb and templates/<template>/detectors
  58       Command: roundup-admin
  59    Roundup DB: roundup.roundupdb
  60      Hyper DB: roundup.hyperdb, roundup.date
  61       Storage: roundup.backends.*
  62
  63 Additionally, there is a directory of unit tests in "test".
  64
  65 For more information, see the original overview and specification documents
  66 written by Ka-Ping Yee in the "doc" directory. If nothing else, it has a
  67 much prettier cake :)
  68 '''
  69
  70 __version__ = '0.5.0'
  71
  72 # vim: set filetype=python ts=4 sw=4 et si