Mercurial > p > roundup > code
comparison roundup/__init__.py @ 106:25216cb3ff79
Added some documentation to the roundup package.
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Sat, 28 Jul 2001 01:39:02 +0000 |
| parents | c7c14960f413 |
| children | 0791d13baea7 |
comparison
equal
deleted
inserted
replaced
| 105:3bed67f2394c | 106:25216cb3ff79 |
|---|---|
| 1 # $Id: __init__.py,v 1.2 2001-07-22 12:09:32 richard Exp $ | 1 # $Id: __init__.py,v 1.3 2001-07-28 01:39:02 richard Exp $ |
| 2 | 2 |
| 3 __doc__ = ''' | |
| 4 This is a simple-to-use and -install issue-tracking system with | |
| 5 command-line, web and e-mail interfaces. | |
| 6 | |
| 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. | |
| 13 | |
| 14 Roundup's structure is that of a cake: | |
| 15 | |
| 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 ------------------------------------------------------------------------- | |
| 27 | |
| 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). | |
| 33 | |
| 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.* | |
| 43 | |
| 44 Additionally, there is a directory of unit tests in "test". | |
| 45 | |
| 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 ''' | |
| 3 | 50 |
| 4 # | 51 # |
| 5 # $Log: not supported by cvs2svn $ | 52 # $Log: not supported by cvs2svn $ |
| 53 # Revision 1.2 2001/07/22 12:09:32 richard | |
| 54 # Final commit of Grande Splite | |
| 6 # | 55 # |
| 56 # |