setup.py

   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.52 2003-05-09 05:28:42 richard Exp $
  20
  21 from distutils.core import setup, Extension
  22 from distutils.util import get_platform
  23 from distutils.command.build_scripts import build_scripts
  24
  25 import sys, os, string
  26 from glob import glob
  27
  28 # patch distutils if it can't cope with the "classifiers" keyword
  29 if sys.version < '2.2.3':
  30     from distutils.dist import DistributionMetadata
  31     DistributionMetadata.classifiers = None
  32     DistributionMetadata.download_url = None
  33
  34
  35 #############################################################################
  36 ### Build script files
  37 #############################################################################
  38
  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.
  42
  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__).
  46
  47         The scripts are created in an uniform scheme: they start the
  48         run() function in the module
  49
  50             <packagename>.scripts.<mangled_scriptname>
  51
  52         The mangling of script names replaces '-' and '/' characters
  53         with '-' and '.', so that they are valid module paths.
  54     """
  55     package_name = None
  56
  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")
  63
  64         to_module = string.maketrans('-/', '_.')
  65
  66         self.mkpath(self.build_dir)
  67         for script in self.scripts:
  68             outfile = os.path.join(self.build_dir, os.path.basename(script))
  69
  70             #if not self.force and not newer(script, outfile):
  71             #    self.announce("not copying %s (up-to-date)" % script)
  72             #    continue
  73
  74             if self.dry_run:
  75                 self.announce("would create %s" % outfile)
  76                 continue
  77
  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['install'].has_key('prefix'):
  82                 prefix = cmdopt['install']['prefix'][1]
  83                 version = '%d.%d'%sys.version_info[:2]
  84                 prefix = '''
  85 import sys
  86 sys.path.insert(1, "%s/lib/python%s/site-packages")
  87 '''%(prefix, version)
  88             else:
  89                 prefix = ''
  90             script_vars = {
  91                 'python': os.path.normpath(sys.executable),
  92                 'package': self.package_name,
  93                 'module': module,
  94                 'prefix': prefix,
  95             }
  96
  97             self.announce("creating %s" % outfile)
  98             file = open(outfile, 'w')
  99
 100             try:
 101                 if sys.platform == "win32":
 102                     file.write('@echo off\n'
 103                         'if NOT "%%_4ver%%" == "" "%(python)s" -O -c "from %(package)s.scripts.%(module)s import run; run()" %%$\n'
 104                         'if     "%%_4ver%%" == "" "%(python)s" -O -c "from %(package)s.scripts.%(module)s import run; run()" %%*\n'
 105                         % script_vars)
 106                 else:
 107                     file.write('#! %(python)s -O\n%(prefix)s'
 108                         'from %(package)s.scripts.%(module)s import run\n'
 109                         'run()\n'
 110                         % script_vars)
 111             finally:
 112                 file.close()
 113                 os.chmod(outfile, 0755)
 114
 115
 116 class build_scripts_roundup(build_scripts_create):
 117     package_name = 'roundup'
 118
 119
 120 def scriptname(path):
 121     """ Helper for building a list of script names from a list of
 122         module files.
 123     """
 124     script = os.path.splitext(os.path.basename(path))[0]
 125     script = string.replace(script, '_', '-')
 126     if sys.platform == "win32":
 127         script = script + ".bat"
 128     return script
 129
 130
 131
 132 #############################################################################
 133 ### Main setup stuff
 134 #############################################################################
 135
 136 def main():
 137     # build list of scripts from their implementation modules
 138     roundup_scripts = map(scriptname, glob('roundup/scripts/[!_]*.py'))
 139
 140     # template munching
 141     packagelist = [
 142         'roundup',
 143         'roundup.cgi',
 144         'roundup.cgi.PageTemplates',
 145         'roundup.cgi.TAL',
 146         'roundup.cgi.ZTUtils',
 147         'roundup.backends',
 148         'roundup.scripts'
 149     ]
 150     installdatafiles = [
 151         ('share/roundup/cgi-bin', ['cgi-bin/roundup.cgi']),
 152     ]
 153
 154     # install man pages on POSIX platforms
 155     if os.name == 'posix':
 156         installdatafiles.append(('man/man1', ['doc/roundup-admin.1',
 157             'doc/roundup-mailgw.1', 'doc/roundup-server.1']))
 158
 159     # add the templates to the data files lists
 160     from roundup.admin import listTemplates
 161     templates = [t['path'] for t in listTemplates('templates').values()]
 162     for tdir in templates:
 163         # scan for data files
 164         for idir in '. detectors html'.split():
 165             idir = os.path.join(tdir, idir)
 166             tfiles = []
 167             for f in os.listdir(idir):
 168                 if f.startswith('.'):
 169                     continue
 170                 ifile = os.path.join(idir, f)
 171                 if os.path.isfile(ifile):
 172                     tfiles.append(ifile)
 173             installdatafiles.append(
 174                 (os.path.join('share', 'roundup', idir), tfiles)
 175             )
 176
 177     # perform the setup action
 178     from roundup import __version__
 179     setup(
 180         name = "roundup",
 181         version = __version__,
 182         description = "Roundup issue tracking system.",
 183         long_description =
 184 '''Roundup is a simple-to-use and -install issue-tracking system with
 185 command-line, web and e-mail interfaces. It is based on the winning design
 186 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
 187
 188 This release has all the bugfixes from the latest 0.5 maintnenance release
 189 plus lots of new goodies including:
 190
 191 - new instant-gratification Demo Mode ("python demo.py" :)
 192 - added mysql backend (see doc/mysql.txt for details)
 193 - web interface cleanups including nicer history display, nicer index
 194   navigation and nicer popup list windows
 195 - searching of date ranges
 196 - better international support, including utf-8 email handling and ability
 197   to display localized dates in web interface.
 198 - more documentation including revamped design document, unix manual pages
 199   and some FAQ entries
 200 - significantly more powerful form handling allowing editing of multiple
 201   items
 202   and creation of multiple items
 203 - tracker templates can contain subdirectories and static files (e.g.
 204   images)
 205   and we may now distribute templates separately from Roundup. Template
 206   HTML files now have a .html extension too.
 207 - user registration is now a two-step process, with confirmation from the email
 208   address supplied in the registration form, and we also have a password reset
 209   feature for forgotten password / login
 210 - Windows Service mode for roundup-server when daemonification is attempted
 211   on Windows.
 212 - fixed issues with dumb email or web clients
 213 - lots more little tweaks and back-end work...
 214 - email system handles more SMTP and POP features (TLS, APOP, ...)
 215 ''',
 216         author = "Richard Jones",
 217         author_email = "richard@users.sourceforge.net",
 218         url = 'http://sourceforge.net/projects/roundup/',
 219         download_url = 'http://sourceforge.net/project/showfiles.php?group_id=31577',
 220         packages = packagelist,
 221         classifiers = [
 222             'Development Status :: 4 - Beta',
 223             'Environment :: Console',
 224             'Environment :: Web Environment',
 225             'Intended Audience :: End Users/Desktop',
 226             'Intended Audience :: Developers',
 227             'Intended Audience :: System Administrators',
 228             'License :: OSI Approved :: Python Software Foundation License',
 229             'Operating System :: MacOS :: MacOS X',
 230             'Operating System :: Microsoft :: Windows',
 231             'Operating System :: POSIX',
 232             'Programming Language :: Python',
 233             'Topic :: Communications :: Email',
 234             'Topic :: Office/Business',
 235             'Topic :: Software Development :: Bug Tracking',
 236         ],
 237
 238         # Override certain command classes with our own ones
 239         cmdclass = {
 240             'build_scripts': build_scripts_roundup,
 241         },
 242         scripts = roundup_scripts,
 243
 244         data_files =  installdatafiles
 245     )
 246
 247 if __name__ == '__main__':
 248     main()
 249
 250 # vim: set filetype=python ts=4 sw=4 et si