Mercurial > p > roundup > code
view roundup/__init__.py @ 7322:485cecfba982
Simplify TOC; older docs pushed a level down; Consolidate debugging
Restructured docs.txt. Pulled out older documents into Old Docs.
I wish I could add whitespace between documents in the toc. Current
order split into groupings:
Roundup Features
Roundup Features
Installing Roundup
Upgrading to newer versions of Roundup
Reporting Security Issues with Roundup
Roundup FAQ
User Guide
Customising Roundup
REST API for Roundup
XML-RPC access to Roundup
Roundup Reference
Roundup Glossary
Administration Guide
License
Acknowledgements
Other Docs
debugging.txt removed. Its contents replaced a reference in
developer.txt.
Added olderdocs for:
docs/upgrading-history
docs/tracker_templates
Design Overview <docs/overview>
Design (original) <docs/design>
docs/developers
Notes about the MySQL Database backend <docs/mysql>
Notes about the PostgreSQL Database backend <docs/postgresql>
Richard Jones implementation notes <docs/implementation>
docs/security-history
to keep them out of the docs.txt sidebar.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 11 May 2023 13:50:57 -0400 |
| parents | a1868fe784d0 |
| children | 623502678b97 |
line wrap: on
line source
# # 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. # '''Roundup - issue tracking for knowledge workers. This is a simple-to-use and -install issue-tracking system with command-line, web and e-mail interfaces. Roundup manages a number of issues (with properties such as "description", "priority", and so on) and provides the ability to (a) submit new issues, (b) find and edit existing issues, and (c) discuss issues with other participants. The system will facilitate communication among the participants by managing discussions and notifying interested parties when issues are edited. 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 | ------------------------------------------------------------------------- 1. The first layer represents the users (chocolate). 2. The second layer is the Roundup interface to the users (vanilla). 3. The third and fourth layers are the internal Roundup database storage mechanisms (strawberry). 4. The final, lowest layer is the underlying database storage (rum). 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 roundup.cgi.client and roundup.cgi.template Detector: roundup.roundupdb and templates/<template>/detectors Command: roundup-admin Roundup DB: roundup.roundupdb Hyper DB: roundup.hyperdb, roundup.date Storage: roundup.backends.* Additionally, there is a directory of unit tests in "test". For more information, see the original overview and specification documents written by Ka-Ping Yee in the "doc" directory. If nothing else, it has a much prettier cake :) ''' __docformat__ = 'restructuredtext' __version__ = '2.2.0' # vim: set filetype=python ts=4 sw=4 et si
