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.58 2003-11-13 05:56:48 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 The 0.6 release has lots of new goodies including:
193 - new instant-gratification Demo Mode ("python demo.py" :)
194 - added mysql backend (see doc/mysql.txt for details)
195 - web interface cleanups including nicer history display, nicer index
196 navigation and nicer popup list windows
197 - searching of date ranges
198 - better international support, including utf-8 email handling and ability
199 to display localized dates in web interface.
200 - more documentation including revamped design document, unix manual pages
201 and some FAQ entries
202 - significantly more powerful form handling allowing editing of multiple
203 items and creation of multiple items
204 - tracker templates can contain subdirectories and static files (e.g.
205 images) and we may now distribute templates separately from Roundup.
206 Template HTML files now have a .html extension too.
207 - user registration is now a two-step process, with confirmation from the
208 email address supplied in the registration form, and we also have a
209 password reset feature for forgotten password / login
210 - Windows Service mode for roundup-server when daemonification is
211 attempted on Windows
212 - lots of speed enhancements, making the web interface much more responsive
213 - fixed issues with dumb email or web clients
214 - email system handles more SMTP and POP features (TLS, APOP, ...)
215 - lots more little tweaks and back-end work...
216 ''',
217 author = "Richard Jones",
218 author_email = "richard@users.sourceforge.net",
219 url = 'http://roundup.sourceforge.net/',
220 download_url = 'http://sourceforge.net/project/showfiles.php?group_id=31577',
221 packages = packagelist,
222 classifiers = [
223 'Development Status :: 5 - Production/Stable',
224 'Environment :: Console',
225 'Environment :: Web Environment',
226 'Intended Audience :: End Users/Desktop',
227 'Intended Audience :: Developers',
228 'Intended Audience :: System Administrators',
229 'License :: OSI Approved :: Python Software Foundation License',
230 'Operating System :: MacOS :: MacOS X',
231 'Operating System :: Microsoft :: Windows',
232 'Operating System :: POSIX',
233 'Programming Language :: Python',
234 'Topic :: Communications :: Email',
235 'Topic :: Office/Business',
236 'Topic :: Software Development :: Bug Tracking',
237 ],
239 # Override certain command classes with our own ones
240 cmdclass = {
241 'build_scripts': build_scripts_roundup,
242 },
243 scripts = roundup_scripts,
245 data_files = installdatafiles
246 )
248 if __name__ == '__main__':
249 main()
251 # vim: set filetype=python ts=4 sw=4 et si