include detectors in distro

[roundup.git] / roundup / __init__.py

diff --git a/roundup/__init__.py b/roundup/__init__.py
index 20a310e8a5c298c3ea315e50639b3af12d5749f7..e7d2da0fa178abae3d28d5421b893d31f6d7f206 100644 (file)
--- a/roundup/__init__.py
+++ b/roundup/__init__.py
@@ -1,6 +1,24 @@
-# $Id: __init__.py,v 1.4 2001-07-29 07:01:39 richard Exp $
+#
+# Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
+# This module is free software, and you may redistribute it and/or modify
+# under the same terms as Python, so long as this copyright message and
+# disclaimer are retained in their original form.
+#
+# IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
+# DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
+# OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#
+# BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
+# BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
+# BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
+# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+# 
+# $Id: __init__.py,v 1.20 2003-02-25 10:19:31 richard Exp $
+
+''' Roundup - issue tracking for knowledge workers.

 
 

-__doc__ = '''

 This is a simple-to-use and -install issue-tracking system with
 command-line, web and e-mail interfaces.
 
 This is a simple-to-use and -install issue-tracking system with
 command-line, web and e-mail interfaces.
 


@@ -11,19 +29,19 @@ other participants. The system will facilitate communication among the
 participants by managing discussions and notifying interested parties when
 issues are edited. 
 
 participants by managing discussions and notifying interested parties when
 issues are edited. 
 

-Roundup's structure is that of a cake:
+Roundup's structure is that of a cake::

 
 

- _________________________________________________________________________
-|  E-mail Client   |   Web Browser   |   Detector Scripts   |    Shell    |
-|------------------+-----------------+----------------------+-------------|
-|   E-mail User    |    Web User     |      Detector        |   Command   | 
-|-------------------------------------------------------------------------|
-|                         Roundup Database Layer                          |
-|-------------------------------------------------------------------------|
-|                          Hyperdatabase Layer                            |
-|-------------------------------------------------------------------------|
-|                             Storage Layer                               |
- -------------------------------------------------------------------------
+  _________________________________________________________________________
+ |  E-mail Client   |   Web Browser   |   Detector Scripts   |    Shell    |
+ |------------------+-----------------+----------------------+-------------|
+ |   E-mail User    |    Web User     |      Detector        |   Command   | 
+ |-------------------------------------------------------------------------|
+ |                         Roundup Database Layer                          |
+ |-------------------------------------------------------------------------|
+ |                          Hyperdatabase Layer                            |
+ |-------------------------------------------------------------------------|
+ |                             Storage Layer                               |
+  -------------------------------------------------------------------------

 
 The first layer represents the users (chocolate).
 The second layer is the Roundup interface to the users (vanilla).
 
 The first layer represents the users (chocolate).
 The second layer is the Roundup interface to the users (vanilla).


@@ -31,10 +49,11 @@ The third and fourth layers are the internal Roundup database storage
   mechanisms (strawberry).
 The final, lowest layer is the underlying database storage (rum).
 
   mechanisms (strawberry).
 The final, lowest layer is the underlying database storage (rum).
 

-These are implemented in the code in the following manner:
+These are implemented in the code in the following manner::
+

   E-mail User: roundup-mailgw and roundup.mailgw
      Web User: cgi-bin/roundup.cgi or roundup-server over
   E-mail User: roundup-mailgw and roundup.mailgw
      Web User: cgi-bin/roundup.cgi or roundup-server over

-               roundup.cgi_client, roundup.cgitb and roundup.htmltemplate
+               roundup.cgi.client and roundup.cgi.template

      Detector: roundup.roundupdb and templates/<template>/detectors
       Command: roundup-admin
    Roundup DB: roundup.roundupdb
      Detector: roundup.roundupdb and templates/<template>/detectors
       Command: roundup-admin
    Roundup DB: roundup.roundupdb


@@ -48,13 +67,6 @@ written by Ka-Ping Yee in the "doc" directory. If nothing else, it has a
 much prettier cake :)
 '''
 
 much prettier cake :)
 '''
 

-#
-# $Log: not supported by cvs2svn $
-# Revision 1.3  2001/07/28 01:39:02  richard
-# Added some documentation to the roundup package.
-#
-# Revision 1.2  2001/07/22 12:09:32  richard
-# Final commit of Grande Splite
-#
-#
+__version__ = '0.6.0pr1'
+

 # vim: set filetype=python ts=4 sw=4 et si
 # vim: set filetype=python ts=4 sw=4 et si