README.txt

   1                                     Roundup
   2                                     =======
   3
   4
   5 1. License
   6 ==========
   7 This software is released under the GNU GPL. The copyright is held by Bizar
   8 Software Pty Ltd (http://www.bizarsoftware.com.au).
   9
  10 The stylesheet included with this package has been copied from the Zope
  11 management interface and presumably belongs to Digital Creations.
  12
  13
  14 2. Installation
  15 ===============
  16 For installation notes, please see the file INSTALL.TXT
  17
  18
  19 3. Usage
  20 ========
  21 The system is designed to accessed through the command-line, e-mail or web
  22 interface. Roundup has some useful doucmentation in its docstrings, so
  23 "pydoc roundup" will give useful information.
  24
  25 3.1 Command-line
  26 ----------------
  27 The command-line tool is called "roundup-admin" and is used for most low-level
  28 database manipulations such as:
  29  . creating a database instance
  30  . redefining the list of products ("create" and "retire" commands)
  31  . adding users manually, or setting their passwords ("create" and "set")
  32  . other stuff - run it with no arguments to get a better description of
  33    what it does.
  34
  35
  36 3.2 E-mail
  37 ----------
  38 See the docstring at the start of the roundup/mailgw.py source file.
  39 Use "pydoc roundup.mailgw".
  40
  41
  42 3.3 Web
  43 -------
  44 Hopefully, this interface is pretty self-explanatory...
  45
  46 Index views may be modified by the following arguments:
  47     :sort    - sort by prop name, optionally preceeded with '-'
  48              to give descending or nothing for ascending sorting.
  49     :group   - group by prop name, optionally preceeded with '-' or
  50              to sort in descending or nothing for ascending order.
  51     :filter  - selects which props should be displayed in the filter
  52              section. Default is all.
  53     :columns - selects the columns that should be displayed.
  54              Default is all.
  55     propname - selects the values the node properties given by propname
  56              must have (very basic search/filter).
  57
  58
  59
  60 3. Design
  61 =========
  62 See the information in the "doc" directory.
  63
  64
  65
  66 4. TODO
  67 =======
  68 Most of the TODO items are captured in comments in the code. In summary:
  69
  70 in general:
  71   . more unit tests
  72   . more back-ends
  73   . better error handling (nicer messages for users)
  74   . possibly revert the entire damn thing to 1.5.2 ... :(
  75 hyperdb:
  76   . transaction support
  77   . more efficient reverse lookups
  78 roundupdb:
  79   . split the file storage into multiple dirs?
  80 roundup-mailgw:
  81   . errors as attachments
  82 roundup-server:
  83   . check the source file timestamps before reloading
  84 cgi_client
  85   . keep form fields in form on bad submission - only clear it if all ok
  86
  87
  88 5. Known Bugs
  89 =============
  90
  91 date:
  92   . date subtraction doesn't work correctly "if the dates cross leap years,
  93     phases of the moon, ..."
  94
  95
  96 6. Author
  97 =========
  98 richard@users.sourceforge.net
  99
 100
 101 7. Thanks
 102 =========
 103 Well, Ping, of course ;)
 104
 105 Anthony Baxter, for some good first-release feedback. And then continuing
 106 support through development on sourceforge.
 107