Mercurial > p > roundup > code

annotate roundup/__init__.py @ 127:0791d13baea7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added vim command to all source so that we don't get no steenkin' tabs :)
author Richard Jones <richard@users.sourceforge.net>
date Sun, 29 Jul 2001 07:01:39 +0000
parents 25216cb3ff79
children d45384bc6420
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
127
0791d13baea7 Added vim command to all source so that we don't get no steenkin' tabs :)
Richard Jones <richard@users.sourceforge.net>
parents: 106
diff changeset
1 # $Id: __init__.py,v 1.4 2001-07-29 07:01:39 richard Exp $
106
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
2
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
3 __doc__ = '''
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
4 This is a simple-to-use and -install issue-tracking system with
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
5 command-line, web and e-mail interfaces.
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
6
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
7 Roundup manages a number of issues (with properties such as
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
8 "description", "priority", and so on) and provides the ability to (a) submit
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
9 new issues, (b) find and edit existing issues, and (c) discuss issues with
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
10 other participants. The system will facilitate communication among the
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
11 participants by managing discussions and notifying interested parties when
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
12 issues are edited.
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
13
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
14 Roundup's structure is that of a cake:
26
c7c14960f413 Final commit of Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents: 25
diff changeset
15
106
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
16 _________________________________________________________________________
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
17 | E-mail Client | Web Browser | Detector Scripts | Shell |
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
18 |------------------+-----------------+----------------------+-------------|
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
19 | E-mail User | Web User | Detector | Command |
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
20 |-------------------------------------------------------------------------|
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
21 | Roundup Database Layer |
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
22 |-------------------------------------------------------------------------|
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
23 | Hyperdatabase Layer |
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
24 |-------------------------------------------------------------------------|
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
25 | Storage Layer |
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
26 -------------------------------------------------------------------------
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
27
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
28 The first layer represents the users (chocolate).
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
29 The second layer is the Roundup interface to the users (vanilla).
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
30 The third and fourth layers are the internal Roundup database storage
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
31 mechanisms (strawberry).
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
32 The final, lowest layer is the underlying database storage (rum).
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
33
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
34 These are implemented in the code in the following manner:
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
35 E-mail User: roundup-mailgw and roundup.mailgw
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
36 Web User: cgi-bin/roundup.cgi or roundup-server over
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
37 roundup.cgi_client, roundup.cgitb and roundup.htmltemplate
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
38 Detector: roundup.roundupdb and templates/<template>/detectors
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
39 Command: roundup-admin
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
40 Roundup DB: roundup.roundupdb
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
41 Hyper DB: roundup.hyperdb, roundup.date
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
42 Storage: roundup.backends.*
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
43
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
44 Additionally, there is a directory of unit tests in "test".
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
45
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
46 For more information, see the original overview and specification documents
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
47 written by Ka-Ping Yee in the "doc" directory. If nothing else, it has a
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
48 much prettier cake :)
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
49 '''
26
c7c14960f413 Final commit of Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents: 25
diff changeset
50
c7c14960f413 Final commit of Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents: 25
diff changeset
51 #
c7c14960f413 Final commit of Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents: 25
diff changeset
52 # $Log: not supported by cvs2svn $
127
0791d13baea7 Added vim command to all source so that we don't get no steenkin' tabs :)
Richard Jones <richard@users.sourceforge.net>
parents: 106
diff changeset
53 # Revision 1.3 2001/07/28 01:39:02 richard
0791d13baea7 Added vim command to all source so that we don't get no steenkin' tabs :)
Richard Jones <richard@users.sourceforge.net>
parents: 106
diff changeset
54 # Added some documentation to the roundup package.
0791d13baea7 Added vim command to all source so that we don't get no steenkin' tabs :)
Richard Jones <richard@users.sourceforge.net>
parents: 106
diff changeset
55 #
106
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
56 # Revision 1.2 2001/07/22 12:09:32 richard
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
57 # Final commit of Grande Splite
26
c7c14960f413 Final commit of Grande Splite
Richard Jones <richard@users.sourceforge.net>
parents: 25
diff changeset
58 #
106
25216cb3ff79 Added some documentation to the roundup package.
Richard Jones <richard@users.sourceforge.net>
parents: 26
diff changeset
59 #
127
0791d13baea7 Added vim command to all source so that we don't get no steenkin' tabs :)
Richard Jones <richard@users.sourceforge.net>
parents: 106
diff changeset
60 # vim: set filetype=python ts=4 sw=4 et si
Roundup Issue Tracker: http://roundup-tracker.org/