README.txt

   1                                     Roundup
   2                                     =======
   3
   4
   5 1. License
   6 ==========
   7
   8 Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
   9 This module is free software, and you may redistribute it and/or modify
  10 under the same terms as Python, so long as this copyright message and
  11 disclaimer are retained in their original form.
  12
  13 IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
  14 DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
  15 OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
  16 POSSIBILITY OF SUCH DAMAGE.
  17
  18 BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  20 FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
  21 BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
  22 SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23
  24
  25 The stylesheet included with this package has been copied from the Zope
  26 management interface and presumably belongs to Digital Creations.
  27
  28
  29 2. Installation
  30 ===============
  31 For installation notes, please see the file INSTALL.TXT
  32
  33
  34 3. Usage
  35 ========
  36 The system is designed to accessed through the command-line, e-mail or web
  37 interface. Roundup has some useful doucmentation in its docstrings, so
  38 "pydoc roundup" will give useful information.
  39
  40 3.1 Command-line
  41 ----------------
  42 The command-line tool is called "roundup-admin" and is used for most low-level
  43 database manipulations such as:
  44  . creating a database instance
  45  . redefining the list of products ("create" and "retire" commands)
  46  . adding users manually, or setting their passwords ("create" and "set")
  47  . other stuff - run it with no arguments to get a better description of
  48    what it does.
  49
  50
  51 3.2 E-mail
  52 ----------
  53 See the docstring at the start of the roundup/mailgw.py source file.
  54 Use "pydoc roundup.mailgw".
  55
  56
  57 3.3 Web
  58 -------
  59 Hopefully, this interface is pretty self-explanatory...
  60
  61 Index views may be modified by the following arguments:
  62     :sort    - sort by prop name, optionally preceeded with '-'
  63              to give descending or nothing for ascending sorting.
  64     :group   - group by prop name, optionally preceeded with '-' or
  65              to sort in descending or nothing for ascending order.
  66     :filter  - selects which props should be displayed in the filter
  67              section. Default is all.
  68     :columns - selects the columns that should be displayed.
  69              Default is all.
  70     propname - selects the values the node properties given by propname
  71              must have (very basic search/filter).
  72
  73
  74
  75 3. Design
  76 =========
  77 See the information in the "doc" directory.
  78
  79
  80
  81 4. TODO
  82 =======
  83 Most of the TODO items are captured in comments in the code. In summary:
  84
  85 in general:
  86   . more unit tests
  87   . more back-ends
  88   . better error handling (nicer messages for users)
  89 hyperdb:
  90   . transaction support
  91   . more efficient reverse lookups
  92 roundupdb:
  93   . split the file storage into multiple dirs?
  94 roundup-mailgw:
  95   . errors as attachments
  96 roundup-server:
  97   . check the source file timestamps before reloading
  98 cgi_client
  99   . keep form fields in form on bad submission - only clear it if all ok
 100
 101
 102 5. Known Bugs
 103 =============
 104
 105 date:
 106   . date subtraction doesn't work correctly "if the dates cross leap years,
 107     phases of the moon, ..."
 108
 109
 110 6. Author
 111 =========
 112 richard@users.sourceforge.net
 113
 114
 115 7. Thanks
 116 =========
 117 Well, Ping, of course ;)
 118
 119 Anthony Baxter, for some good first-release feedback. And then continuing
 120 support through development on sourceforge.
 121