Code

much nicer error messages when there's a templating error
[roundup.git] / setup.py
index 75f4fc5c550b9141d40fcb7e5f88807856dd8418..b146d8289e938ac41154d4410288a661d53edfb6 100644 (file)
--- a/setup.py
+++ b/setup.py
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: setup.py,v 1.28 2002-01-11 03:24:15 richard Exp $
+# $Id: setup.py,v 1.37 2002-09-06 04:25:31 richard Exp $
 
 from distutils.core import setup, Extension
 from distutils.util import get_platform
+from distutils.command.build_scripts import build_scripts
 
+import sys, os, string
 from glob import glob
-import sys,os
-from roundup.templatebuilder import makeHtmlBase
 
-print 'Running unit tests...'
-import test
-if not test.go():
-    sys.exit(0)
+from roundup.templates.builder import makeHtmlBase
 
 
+#############################################################################
+### Build script files
+#############################################################################
+
+class build_scripts_create(build_scripts):
+    """ Overload the build_scripts command and create the scripts
+        from scratch, depending on the target platform.
+
+        You have to define the name of your package in an inherited
+        class (due to the delayed instantiation of command classes
+        in distutils, this cannot be passed to __init__).
+
+        The scripts are created in an uniform scheme: they start the
+        run() function in the module
+
+            <packagename>.scripts.<mangled_scriptname>
+
+        The mangling of script names replaces '-' and '/' characters
+        with '-' and '.', so that they are valid module paths. 
+    """
+    package_name = None
+
+    def copy_scripts(self):
+        """ Create each script listed in 'self.scripts'
+        """
+        if not self.package_name:
+            raise Exception("You have to inherit build_scripts_create and"
+                " provide a package name")
+        
+        to_module = string.maketrans('-/', '_.')
+
+        self.mkpath(self.build_dir)
+        for script in self.scripts:
+            outfile = os.path.join(self.build_dir, os.path.basename(script))
+
+            #if not self.force and not newer(script, outfile):
+            #    self.announce("not copying %s (up-to-date)" % script)
+            #    continue
+
+            if self.dry_run:
+                self.announce("would create %s" % outfile)
+                continue
+
+            module = os.path.splitext(os.path.basename(script))[0]
+            module = string.translate(module, to_module)
+            script_vars = {
+                'python': os.path.normpath(sys.executable),
+                'package': self.package_name,
+                'module': module,
+            }
+
+            self.announce("creating %s" % outfile)
+            file = open(outfile, 'w')
+
+            try:
+                if sys.platform == "win32":
+                    file.write('@echo off\n'
+                        'if NOT "%%_4ver%%" == "" %(python)s -c "from %(package)s.scripts.%(module)s import run; run()" %%$\n'
+                        'if     "%%_4ver%%" == "" %(python)s -c "from %(package)s.scripts.%(module)s import run; run()" %%*\n'
+                        % script_vars)
+                else:
+                    file.write('#! %(python)s\n'
+                        'from %(package)s.scripts.%(module)s import run\n'
+                        'run()\n'
+                        % script_vars)
+            finally:
+                file.close()
+                os.chmod(outfile, 0755)
+
+
+class build_scripts_roundup(build_scripts_create):
+    package_name = 'roundup'
+
+
+def scriptname(path):
+    """ Helper for building a list of script names from a list of
+        module files.
+    """
+    script = os.path.splitext(os.path.basename(path))[0]
+    script = string.replace(script, '_', '-')
+    if sys.platform == "win32":
+        script = script + ".bat"
+    return script
+
+
+
+#############################################################################
+### Main setup stuff
+#############################################################################
+
 def isTemplateDir(dir):
     return dir[0] != '.' and dir != 'CVS' and os.path.isdir(dir) \
         and os.path.isfile(os.path.join(dir, '__init__.py'))
 
+# use that function to list all the templates
 templates = map(os.path.basename, filter(isTemplateDir,
     glob(os.path.join('roundup', 'templates', '*'))))
-packagelist = [
-    'roundup',
-    'roundup.backends',
-    'roundup.templates'
-]
-installdatafiles = [
-    ('share/roundup/cgi-bin', ['cgi-bin/roundup.cgi']),
-] 
-
-for template in templates:
-    tdir = os.path.join('roundup', 'templates', template)
-    makeHtmlBase(tdir)
-
-    # add the template package and subpackage
-    packagelist.append('roundup.templates.%s' % template)
-    packagelist.append('roundup.templates.%s.detectors' % template)
-
-    # scan for data files
-    tfiles = glob(os.path.join(tdir, 'html', '*'))
-    tfiles = filter(os.path.isfile, tfiles)
-    installdatafiles.append(
-        ('share/roundup/templates/%s/html' % template, tfiles)
-    )
 
+def buildTemplates():
+    for template in templates:
+        tdir = os.path.join('roundup', 'templates', template)
+        makeHtmlBase(tdir)
+
+if __name__ == '__main__':
+    # build list of scripts from their implementation modules
+    roundup_scripts = map(scriptname, glob('roundup/scripts/[!_]*.py'))
+
+    # template munching
+    templates = map(os.path.basename, filter(isTemplateDir,
+        glob(os.path.join('roundup', 'templates', '*'))))
+    packagelist = [
+        'roundup',
+        'roundup.cgi',
+        'roundup.cgi.PageTemplates',
+        'roundup.cgi.TAL',
+        'roundup.cgi.ZTUtils',
+        'roundup.backends',
+        'roundup.scripts',
+        'roundup.templates'
+    ]
+    installdatafiles = [
+        ('share/roundup/cgi-bin', ['cgi-bin/roundup.cgi']),
+    ] 
+
+    # munge the template HTML into the htmlbase module
+    buildTemplates()
+
+    # add the templates to the setup packages and data files lists
+    for template in templates:
+        tdir = os.path.join('roundup', 'templates', template)
 
-setup(
-    name = "roundup", 
-    version = "0.4.0b2",
-    description = "Roundup issue tracking system.",
-    author = "Richard Jones",
-    author_email = "richard@users.sourceforge.net",
-    url = 'http://sourceforge.net/projects/roundup/',
-    packages = packagelist,
-    scripts = ['roundup-admin', 'roundup-mailgw', 'roundup-server'],
-    data_files =  installdatafiles
-)
+        # add the template package and subpackage
+        packagelist.append('roundup.templates.%s' % template)
+        packagelist.append('roundup.templates.%s.detectors' % template)
+
+        # scan for data files
+        tfiles = glob(os.path.join(tdir, 'html', '*'))
+        tfiles = filter(os.path.isfile, tfiles)
+        installdatafiles.append(
+            ('share/roundup/templates/%s/html' % template, tfiles)
+        )
+
+    # perform the setup action
+    from roundup import __version__
+    setup(
+        name = "roundup", 
+        version = __version__,
+        description = "Roundup issue tracking system.",
+        author = "Richard Jones",
+        author_email = "richard@users.sourceforge.net",
+        url = 'http://sourceforge.net/projects/roundup/',
+        packages = packagelist,
+
+        # Override certain command classes with our own ones
+        cmdclass = {
+            'build_scripts': build_scripts_roundup,
+        },
+        scripts = roundup_scripts,
+
+        data_files =  installdatafiles
+    )
 
 
 #
 # $Log: not supported by cvs2svn $
+# Revision 1.36  2002/08/16 04:25:01  richard
+# cleanup: moved templatebuilder into templates.builder
+#
+# Revision 1.35  2002/06/17 23:14:44  richard
+# . #569415 ] {version}
+#
+# Revision 1.34  2002/05/29 01:16:16  richard
+# Sorry about this huge checkin! It's fixing a lot of related stuff in one go
+# though.
+#
+# . #541941 ] changing multilink properties by mail
+# . #526730 ] search for messages capability
+# . #505180 ] split MailGW.handle_Message
+#   - also changed cgi client since it was duplicating the functionality
+# . build htmlbase if tests are run using CVS checkout (removed note from
+#   installation.txt)
+# . don't create an empty message on email issue creation if the email is empty
+#
+# Revision 1.33  2002/04/03 05:53:03  richard
+# Didn't get around to committing these after the last release.
+#
+# Revision 1.32  2002/03/27 23:47:58  jhermann
+# Fix for scripts running under CMD.EXE
+#
+# Revision 1.31  2002/03/22 18:36:00  jhermann
+# chmod +x for scripts
+#
+# Revision 1.30  2002/01/29 20:07:15  jhermann
+# Conversion to generated script stubs
+#
+# Revision 1.29  2002/01/23 06:05:36  richard
+# prep work for release
+#
+# Revision 1.28  2002/01/11 03:24:15  richard
+# minor changes for 0.4.0b2
+#
 # Revision 1.27  2002/01/05 02:09:46  richard
 # make setup abort if tests fail
 #