1 # $Id: __init__.py,v 1.3 2001-07-28 01:39:02 richard Exp $
3 __doc__ = '''
4 This is a simple-to-use and -install issue-tracking system with
5 command-line, web and e-mail interfaces.
7 Roundup manages a number of issues (with properties such as
8 "description", "priority", and so on) and provides the ability to (a) submit
9 new issues, (b) find and edit existing issues, and (c) discuss issues with
10 other participants. The system will facilitate communication among the
11 participants by managing discussions and notifying interested parties when
12 issues are edited.
14 Roundup's structure is that of a cake:
16 _________________________________________________________________________
17 | E-mail Client | Web Browser | Detector Scripts | Shell |
18 |------------------+-----------------+----------------------+-------------|
19 | E-mail User | Web User | Detector | Command |
20 |-------------------------------------------------------------------------|
21 | Roundup Database Layer |
22 |-------------------------------------------------------------------------|
23 | Hyperdatabase Layer |
24 |-------------------------------------------------------------------------|
25 | Storage Layer |
26 -------------------------------------------------------------------------
28 The first layer represents the users (chocolate).
29 The second layer is the Roundup interface to the users (vanilla).
30 The third and fourth layers are the internal Roundup database storage
31 mechanisms (strawberry).
32 The final, lowest layer is the underlying database storage (rum).
34 These are implemented in the code in the following manner:
35 E-mail User: roundup-mailgw and roundup.mailgw
36 Web User: cgi-bin/roundup.cgi or roundup-server over
37 roundup.cgi_client, roundup.cgitb and roundup.htmltemplate
38 Detector: roundup.roundupdb and templates/<template>/detectors
39 Command: roundup-admin
40 Roundup DB: roundup.roundupdb
41 Hyper DB: roundup.hyperdb, roundup.date
42 Storage: roundup.backends.*
44 Additionally, there is a directory of unit tests in "test".
46 For more information, see the original overview and specification documents
47 written by Ka-Ping Yee in the "doc" directory. If nothing else, it has a
48 much prettier cake :)
49 '''
51 #
52 # $Log: not supported by cvs2svn $
53 # Revision 1.2 2001/07/22 12:09:32 richard
54 # Final commit of Grande Splite
55 #
56 #