Mercurial > p > roundup > code

annotate README.txt @ 213:d45384bc6420

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added the copyright/license notice to (nearly) all files... ...at request of Bizar Software.
author Richard Jones <richard@users.sourceforge.net>
date Tue, 07 Aug 2001 00:15:51 +0000
parents bbf77ee013cf
children 18134bffab37
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 ==========
213
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
7
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
8 Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
9 This module is free software, and you may redistribute it and/or modify
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
10 under the same terms as Python, so long as this copyright message and
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
11 disclaimer are retained in their original form.
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
12
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
13 IN NO EVENT SHALL THE BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
14 DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
15 OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
16 POSSIBILITY OF SUCH DAMAGE.
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
17
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
18 BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
19 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
20 FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
21 BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
22 SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
d45384bc6420 Added the copyright/license notice to (nearly) all files...
Richard Jones <richard@users.sourceforge.net>
parents: 211
diff changeset
23
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25 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
26 management interface and presumably belongs to Digital Creations.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 2. Installation
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 ===============
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 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
32
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 3. Usage
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 ========
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 The system is designed to accessed through the command-line, e-mail or web
194
30c3a37b699f Started stuff off for the 0.2.5 release
Richard Jones <richard@users.sourceforge.net>
parents: 189
diff changeset
37 interface. Roundup has some useful doucmentation in its docstrings, so
30c3a37b699f Started stuff off for the 0.2.5 release
Richard Jones <richard@users.sourceforge.net>
parents: 189
diff changeset
38 "pydoc roundup" will give useful information.
94
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.1 Command-line
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 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
43 database manipulations such as:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 . creating a database instance
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45 . 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
46 . 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
47 . 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
48 what it does.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
49
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
50
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
51 3.2 E-mail
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
52 ----------
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53 See the docstring at the start of the roundup/mailgw.py source file.
194
30c3a37b699f Started stuff off for the 0.2.5 release
Richard Jones <richard@users.sourceforge.net>
parents: 189
diff changeset
54 Use "pydoc roundup.mailgw".
94
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 3.3 Web
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
58 -------
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
59 Hopefully, this interface is pretty self-explanatory...
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
60
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
61 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
62 :sort - sort by prop name, optionally preceeded with '-'
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
63 to give descending or nothing for ascending sorting.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
64 :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
65 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
66 :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
67 section. Default is all.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
68 :columns - selects the columns that should be displayed.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
69 Default is all.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
70 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
71 must have (very basic search/filter).
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
72
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
73
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
74
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
75 3. Design
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
76 =========
111
6e8197a5880f Split off implementation notes into separate file in doc directory.
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
77 See the information in the "doc" directory.
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
78
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
79
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
80
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
81 4. TODO
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
82 =======
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
83 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
84
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
85 in general:
111
6e8197a5880f Split off implementation notes into separate file in doc directory.
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
86 . more unit tests
6e8197a5880f Split off implementation notes into separate file in doc directory.
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
87 . more back-ends
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
88 . better error handling (nicer messages for users)
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
89 . 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
90 hyperdb:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
91 . transaction support
127
0791d13baea7 Added vim command to all source so that we don't get no steenkin' tabs :)
Richard Jones <richard@users.sourceforge.net>
parents: 112
diff changeset
92 . more efficient reverse lookups
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
93 roundupdb:
112
e4170b2b2561 todo refinement ;)
Richard Jones <richard@users.sourceforge.net>
parents: 111
diff changeset
94 . split the file storage into multiple dirs?
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
95 roundup-mailgw:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
96 . errors as attachments
111
6e8197a5880f Split off implementation notes into separate file in doc directory.
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
97 roundup-server:
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
98 . check the source file timestamps before reloading
111
6e8197a5880f Split off implementation notes into separate file in doc directory.
Richard Jones <richard@users.sourceforge.net>
parents: 98
diff changeset
99 cgi_client
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
100 . keep form fields in form on bad submission - only clear it if all ok
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
101
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 5. Known Bugs
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
104 =============
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
105
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
106 date:
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
107 . 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
108 phases of the moon, ..."
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
109
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 6. Author
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
112 =========
194
30c3a37b699f Started stuff off for the 0.2.5 release
Richard Jones <richard@users.sourceforge.net>
parents: 189
diff changeset
113 richard@users.sourceforge.net
94
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
114
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
115
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
116 7. Thanks
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
117 =========
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
118 Well, Ping, of course ;)
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
119
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
120 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
121 support through development on sourceforge.
9cf5229397fc name changes to make distutils happy
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
122
Roundup Issue Tracker: http://roundup-tracker.org/