Mercurial > p > roundup > code

comparison roundup/init.py @ 2005:fc52d57c6c3e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
documentation cleanup
author Richard Jones <richard@users.sourceforge.net>
date Wed, 11 Feb 2004 23:55:10 +0000
parents d157b9b56ebf
children a9e1fff1e793
comparison
equal deleted inserted replaced
2004:1782fe36e7b8 2005:fc52d57c6c3e
13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" 14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, 15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. 16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
17 # 17 #
18 # $Id: init.py,v 1.28 2003-11-13 04:12:10 richard Exp $ 18 # $Id: init.py,v 1.29 2004-02-11 23:55:08 richard Exp $
19 19
20 __doc__ = """ 20 """Init (create) a roundup instance.
21 Init (create) a roundup instance.
22 """ 21 """
22 __docformat__ = 'restructuredtext'
23 23
24 import os, sys, errno, rfc822 24 import os, sys, errno, rfc822
25 25
26 import roundup.instance, password 26 import roundup.instance, password
27 from roundup import install_util 27 from roundup import install_util
55 install_util.copyDigestedFile(srcname, dstname) 55 install_util.copyDigestedFile(srcname, dstname)
56 56
57 def install(instance_home, template): 57 def install(instance_home, template):
58 '''Install an instance using the named template and backend. 58 '''Install an instance using the named template and backend.
59 59
60 instance_home - the directory to place the instance data in 60 'instance_home'
61 template - the directory holding the template to use in creating 61 the directory to place the instance data in
62 the instance data 62 'template'
63 the directory holding the template to use in creating the instance data
63 64
64 The instance_home directory will be created using the files found in 65 The instance_home directory will be created using the files found in
65 the named template (roundup.templates.<name>). A standard instance_home 66 the named template (roundup.templates.<name>). A standard instance_home
66 contains: 67 contains:
67 . config.py
68 - simple configuration of things like the email address for the
69 mail gateway, the mail domain, the mail host, ...
70 . dbinit.py and select_db.py
71 - defines the schema for the hyperdatabase and indicates which
72 backend to use.
73 . interfaces.py
74 - defines the CGI Client and mail gateway MailGW classes that are
75 used by roundup.cgi, roundup-server and roundup-mailgw.
76 . __init__.py
77 - ties together all the instance information into one interface
78 . db/
79 - the actual database that stores the instance's data
80 . html/
81 - the html templates that are used by the CGI Client
82 . detectors/
83 - the auditor and reactor modules for this instance
84 68
69 config.py
70 simple configuration of things like the email address for the
71 mail gateway, the mail domain, the mail host, ...
72 dbinit.py and select_db.py
73 defines the schema for the hyperdatabase and indicates which
74 backend to use.
75 interfaces.py
76 defines the CGI Client and mail gateway MailGW classes that are
77 used by roundup.cgi, roundup-server and roundup-mailgw.
78 __init__.py
79 ties together all the instance information into one interface
80 db/
81 the actual database that stores the instance's data
82 html/
83 the html templates that are used by the CGI Client
84 detectors/
85 the auditor and reactor modules for this instance
85 ''' 86 '''
86 # At the moment, it's just a copy 87 # At the moment, it's just a copy
87 copytree(template, instance_home) 88 copytree(template, instance_home)
88 89
89 # rename the tempate in the TEMPLATE-INFO.txt file 90 # rename the tempate in the TEMPLATE-INFO.txt file
Roundup Issue Tracker: http://roundup-tracker.org/