1 #! /usr/bin/env python
2 #
3 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
4 # This module is free software, and you may redistribute it and/or modify
5 # under the same terms as Python, so long as this copyright message and
6 # disclaimer are retained in their original form.
7 #
8 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
9 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
10 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
11 # POSSIBILITY OF SUCH DAMAGE.
12 #
13 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
14 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
15 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
16 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
17 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
18 #
19 # $Id: setup.py,v 1.59 2004-03-24 05:56:06 richard Exp $
21 from distutils.core import setup, Extension
22 from distutils.util import get_platform
23 from distutils.command.build_scripts import build_scripts
25 import sys, os, string
26 from glob import glob
28 # patch distutils if it can't cope with the "classifiers" keyword
29 from distutils.dist import DistributionMetadata
30 if not hasattr(DistributionMetadata, 'classifiers'):
31 DistributionMetadata.classifiers = None
32 DistributionMetadata.download_url = None
35 #############################################################################
36 ### Build script files
37 #############################################################################
39 class build_scripts_create(build_scripts):
40 """ Overload the build_scripts command and create the scripts
41 from scratch, depending on the target platform.
43 You have to define the name of your package in an inherited
44 class (due to the delayed instantiation of command classes
45 in distutils, this cannot be passed to __init__).
47 The scripts are created in an uniform scheme: they start the
48 run() function in the module
50 <packagename>.scripts.<mangled_scriptname>
52 The mangling of script names replaces '-' and '/' characters
53 with '-' and '.', so that they are valid module paths.
54 """
55 package_name = None
57 def copy_scripts(self):
58 """ Create each script listed in 'self.scripts'
59 """
60 if not self.package_name:
61 raise Exception("You have to inherit build_scripts_create and"
62 " provide a package name")
64 to_module = string.maketrans('-/', '_.')
66 self.mkpath(self.build_dir)
67 for script in self.scripts:
68 outfile = os.path.join(self.build_dir, os.path.basename(script))
70 #if not self.force and not newer(script, outfile):
71 # self.announce("not copying %s (up-to-date)" % script)
72 # continue
74 if self.dry_run:
75 self.announce("would create %s" % outfile)
76 continue
78 module = os.path.splitext(os.path.basename(script))[0]
79 module = string.translate(module, to_module)
80 cmdopt=self.distribution.command_options
81 if (cmdopt.has_key('install') and
82 cmdopt['install'].has_key('prefix')):
83 prefix = cmdopt['install']['prefix'][1]
84 version = '%d.%d'%sys.version_info[:2]
85 prefix = '''
86 import sys
87 sys.path.insert(1, "%s/lib/python%s/site-packages")
88 '''%(prefix, version)
89 else:
90 prefix = ''
91 script_vars = {
92 'python': os.path.normpath(sys.executable),
93 'package': self.package_name,
94 'module': module,
95 'prefix': prefix,
96 }
98 self.announce("creating %s" % outfile)
99 file = open(outfile, 'w')
101 try:
102 if sys.platform == "win32":
103 file.write('@echo off\n'
104 'if NOT "%%_4ver%%" == "" "%(python)s" -O -c "from %(package)s.scripts.%(module)s import run; run()" %%$\n'
105 'if "%%_4ver%%" == "" "%(python)s" -O -c "from %(package)s.scripts.%(module)s import run; run()" %%*\n'
106 % script_vars)
107 else:
108 file.write('#! %(python)s -O\n%(prefix)s'
109 'from %(package)s.scripts.%(module)s import run\n'
110 'run()\n'
111 % script_vars)
112 finally:
113 file.close()
114 os.chmod(outfile, 0755)
117 class build_scripts_roundup(build_scripts_create):
118 package_name = 'roundup'
121 def scriptname(path):
122 """ Helper for building a list of script names from a list of
123 module files.
124 """
125 script = os.path.splitext(os.path.basename(path))[0]
126 script = string.replace(script, '_', '-')
127 if sys.platform == "win32":
128 script = script + ".bat"
129 return script
133 #############################################################################
134 ### Main setup stuff
135 #############################################################################
137 def main():
138 # build list of scripts from their implementation modules
139 roundup_scripts = map(scriptname, glob('roundup/scripts/[!_]*.py'))
141 # template munching
142 packagelist = [
143 'roundup',
144 'roundup.cgi',
145 'roundup.cgi.PageTemplates',
146 'roundup.cgi.TAL',
147 'roundup.cgi.ZTUtils',
148 'roundup.backends',
149 'roundup.scripts'
150 ]
151 installdatafiles = [
152 ('share/roundup/cgi-bin', ['cgi-bin/roundup.cgi']),
153 ]
155 # install man pages on POSIX platforms
156 if os.name == 'posix':
157 installdatafiles.append(('man/man1', ['doc/roundup-admin.1',
158 'doc/roundup-mailgw.1', 'doc/roundup-server.1']))
160 # add the templates to the data files lists
161 from roundup.init import listTemplates
162 templates = [t['path'] for t in listTemplates('templates').values()]
163 for tdir in templates:
164 # scan for data files
165 for idir in '. detectors html'.split():
166 idir = os.path.join(tdir, idir)
167 tfiles = []
168 for f in os.listdir(idir):
169 if f.startswith('.'):
170 continue
171 ifile = os.path.join(idir, f)
172 if os.path.isfile(ifile):
173 tfiles.append(ifile)
174 installdatafiles.append(
175 (os.path.join('share', 'roundup', idir), tfiles)
176 )
178 # perform the setup action
179 from roundup import __version__
180 setup(
181 name = "roundup",
182 version = __version__,
183 description = "A simple-to-use and -install issue-tracking system"
184 " with command-line, web and e-mail interfaces. Highly"
185 " customisable.",
186 long_description =
187 '''Roundup is a simple-to-use and -install issue-tracking system with
188 command-line, web and e-mail interfaces. It is based on the winning design
189 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
191 If you're upgrading from an older version of Roundup you *must* follow
192 the "Software Upgrade" guidelines given in the maintenance documentation.
194 No, really, this is a BETA and if you don't follow the upgrading steps,
195 particularly the bit about BACKING UP YOUR DATA, I'm NOT GOING TO BE HELD
196 RESPONSIBLE. This release is NOT FOR GENERAL USE.
198 I would *greatly* appreciate people giving this release a whirl with a
199 copy of their existing setup. It's only through real-world testing of
200 beta releases that we can ensure that older trackers will be OK.
202 This release introduces far too many features to list here. Some
203 highlights:
205 - added postgresql backend (originally from sf patch 761740, many changes
206 since)
207 - RDBMS backends implement their session and one-time-key stores and
208 full-text indexers; thus they are now performing their own locking
209 internally
210 - added new "actor" automatic property (indicates user who cause the last
211 "activity")
212 - all RDBMS backends have sensible data typed columns and indexes on
213 several columns
214 - we support confirming registration by replying to the email (sf bug
215 763668)
216 - all HTML templating methods now automatically check for permissions
217 (either view or edit as appropriate), greatly simplifying templates
218 ''',
219 author = "Richard Jones",
220 author_email = "richard@users.sourceforge.net",
221 url = 'http://roundup.sourceforge.net/',
222 download_url = 'http://sourceforge.net/project/showfiles.php?group_id=31577',
223 packages = packagelist,
224 classifiers = [
225 'Development Status :: 4 - Beta',
226 'Environment :: Console',
227 'Environment :: Web Environment',
228 'Intended Audience :: End Users/Desktop',
229 'Intended Audience :: Developers',
230 'Intended Audience :: System Administrators',
231 'License :: OSI Approved :: Python Software Foundation License',
232 'Operating System :: MacOS :: MacOS X',
233 'Operating System :: Microsoft :: Windows',
234 'Operating System :: POSIX',
235 'Programming Language :: Python',
236 'Topic :: Communications :: Email',
237 'Topic :: Office/Business',
238 'Topic :: Software Development :: Bug Tracking',
239 ],
241 # Override certain command classes with our own ones
242 cmdclass = {
243 'build_scripts': build_scripts_roundup,
244 },
245 scripts = roundup_scripts,
247 data_files = installdatafiles
248 )
250 if __name__ == '__main__':
251 main()
253 # vim: set filetype=python ts=4 sw=4 et si