Mercurial > p > roundup > code

annotate README.txt @ 111:6e8197a5880f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Split off implementation notes into separate file in doc directory. Added some todo items to the README
author Richard Jones <richard@users.sourceforge.net>
date Sat, 28 Jul 2001 06:44:34 +0000
parents 16dcdab5ce70
children e4170b2b2561
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 Roundup
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 =======
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 1. License
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 ==========
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 This software is released under the GNU GPL. The copyright is held by Bizar
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 Software Pty Ltd (http://www.bizarsoftware.com.au).
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 The stylesheet included with this package has been copied from the Zope
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 management interface and presumably belongs to Digital Creations.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 2. Installation
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 ===============
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 For installation notes, please see the file INSTALL.TXT
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19 3. Usage
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 ========
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 The system is designed to accessed through the command-line, e-mail or web
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 interface.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24 3.1 Command-line
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25 ----------------
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 The command-line tool is called "roundup-admin" and is used for most low-level
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 database manipulations such as:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28 . creating a database instance
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 . redefining the list of products ("create" and "retire" commands)
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 . adding users manually, or setting their passwords ("create" and "set")
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 . other stuff - run it with no arguments to get a better description of
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32 what it does.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 3.2 E-mail
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 ----------
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 See the docstring at the start of the roundup/mailgw.py source file.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40 3.3 Web
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 -------
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42 Hopefully, this interface is pretty self-explanatory...
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 Index views may be modified by the following arguments:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45 :sort - sort by prop name, optionally preceeded with '-'
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 to give descending or nothing for ascending sorting.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 :group - group by prop name, optionally preceeded with '-' or
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 to sort in descending or nothing for ascending order.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49 :filter - selects which props should be displayed in the filter
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50 section. Default is all.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51 :columns - selects the columns that should be displayed.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 Default is all.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53 propname - selects the values the node properties given by propname
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
54 must have (very basic search/filter).
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
55
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
56
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
57
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58 3. Design
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59 =========
111
6e8197a5880f Split off implementation notes into separate file in doc directory.
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
60 See the information in the "doc" directory.
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
62
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64 4. TODO
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
65 =======
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
66 Most of the TODO items are captured in comments in the code. In summary:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
67
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
68 in general:
111
6e8197a5880f Split off implementation notes into separate file in doc directory.
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
69 . more unit tests
6e8197a5880f Split off implementation notes into separate file in doc directory.
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
70 . more back-ends
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
71 . better error handling (nicer messages for users)
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
72 . possibly revert the entire damn thing to 1.5.2 ... :(
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73 roundup.py:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74 . getopt() for command line
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75 hyperdb:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
76 . transaction support
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
77 roundupdb:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
78 . split the file storage into multiple files
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
79 roundup-mailgw:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
80 . errors as attachments
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
81 . snip signatures?
111
6e8197a5880f Split off implementation notes into separate file in doc directory.
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
82 roundup-server:
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
83 . check the source file timestamps before reloading
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
84 date:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
85 . blue Date.__sub__ needs food, badly
111
6e8197a5880f Split off implementation notes into separate file in doc directory.
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
86 cgi_client
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
87 . searching
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
88 . keep form fields in form on bad submission - only clear it if all ok
111
6e8197a5880f Split off implementation notes into separate file in doc directory.
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
89 . e-mail messages should have the roundup CGI URL in them
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
90
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
91
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
92 5. Known Bugs
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
93 =============
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
95 date:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
96 . date subtraction doesn't work correctly "if the dates cross leap years,
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
97 phases of the moon, ..."
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
98
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
99 filter:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
100 . incorrectly embeds hidden fields for filters being displayed - and
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
101 doesn't use the existing values for filters being displayed either.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
102
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
103
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
104 6. Author
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
105 =========
98
16dcdab5ce70 Added build instructions...
Richard Jones <richard@users.sourceforge.net>
parents: 94
diff changeset
106 richard@sourceforge.net
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
107
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
108
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
109 7. Thanks
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
110 =========
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
111 Well, Ping, of course ;)
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
112
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
113 Anthony Baxter, for some good first-release feedback. And then continuing
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
114 support through development on sourceforge.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
115
Roundup Issue Tracker: http://roundup-tracker.org/