Code

- fix mailgw list of methods -- use getattr so that a derived class will
[roundup.git] / setup.py
index 1a9c5ae41abf0d238921c5b86adb508bdfe6e18c..8fe03db6e38a8a163c7d92e1d990ecf15e61d512 100644 (file)
--- a/setup.py
+++ b/setup.py
 # FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
-# 
-# $Id: setup.py,v 1.61 2004-04-17 01:47:15 richard Exp $
+#
+
 
-from distutils.core import setup, Extension
-from distutils.util import get_platform
-from distutils.command.build_scripts import build_scripts
-from distutils.command.build import build
+from roundup.dist.command.build_doc import build_doc
+from roundup.dist.command.build_scripts import build_scripts
+from roundup.dist.command.build_py import build_py
+from roundup.dist.command.build import build, list_message_files
+from roundup.dist.command.bdist_rpm import bdist_rpm
+from roundup.dist.command.install_lib import install_lib
+from distutils.core import setup
 
-import sys, os, string
+import sys, os
 from glob import glob
 
 # patch distutils if it can't cope with the "classifiers" keyword
@@ -32,248 +35,120 @@ if not hasattr(DistributionMetadata, 'classifiers'):
     DistributionMetadata.classifiers = None
     DistributionMetadata.download_url = None
 
+def include(d, e):
+    """Generate a pair of (directory, file-list) for installation.
 
-#############################################################################
-### 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))
+    'd' -- A directory
 
-            #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)
-            cmdopt=self.distribution.command_options
-            if (cmdopt.has_key('install') and
-                cmdopt['install'].has_key('prefix')):
-                prefix = cmdopt['install']['prefix'][1]
-                version = '%d.%d'%sys.version_info[:2]
-                prefix = '''
-import sys
-sys.path.insert(1, "%s/lib/python%s/site-packages")
-'''%(prefix, version)
-            else:
-                prefix = ''
-            script_vars = {
-                'python': os.path.normpath(sys.executable),
-                'package': self.package_name,
-                'module': module,
-                'prefix': prefix,
-            }
-
-            self.announce("creating %s" % outfile)
-            file = open(outfile, 'w')
-
-            try:
-                if sys.platform == "win32":
-                    file.write('@echo off\n'
-                        'if NOT "%%_4ver%%" == "" "%(python)s" -O -c "from %(package)s.scripts.%(module)s import run; run()" %%$\n'
-                        'if     "%%_4ver%%" == "" "%(python)s" -O -c "from %(package)s.scripts.%(module)s import run; run()" %%*\n'
-                        % script_vars)
-                else:
-                    file.write('#! %(python)s -O\n%(prefix)s'
-                        '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'
+    'e' -- A glob pattern"""
 
+    return (d, [f for f in glob('%s/%s'%(d, e)) if os.path.isfile(f)])
 
 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"
+    script = script.replace('_', '-')
     return script
 
-def check_manifest():
-    """Check that the files listed in the MANIFEST are present when the
-    source is unpacked.
-    """
-    try:
-        f = open('MANIFEST')
-    except:
-        print '\n*** SOURCE ERROR: The MANIFEST file is missing!'
-        sys.exit(1)
-    try:
-        manifest = [l.strip() for l in f.readlines()]
-    finally:
-        f.close()
-    err = [line for line in manifest if not os.path.exists(line)]
-    if err:
-        n = len(manifest)
-        print '\n*** SOURCE ERROR: There are files missing (%d/%d found)!'%(
-            n-len(err), n)
-        sys.exit(1)
-
-
-class build_roundup(build):
-    def run(self):
-        check_manifest()
-        build.run(self)
-
-#############################################################################
-### Main setup stuff
-#############################################################################
-
 def main():
-    # build list of scripts from their implementation modules
-    roundup_scripts = map(scriptname, glob('roundup/scripts/[!_]*.py'))
-
     # template munching
-    packagelist = [
+    packages = [
         'roundup',
+        'roundup.anypy',
         'roundup.cgi',
         'roundup.cgi.PageTemplates',
         'roundup.cgi.TAL',
         'roundup.cgi.ZTUtils',
         'roundup.backends',
-        'roundup.scripts'
+        'roundup.scripts',
     ]
-    installdatafiles = [
-        ('share/roundup/cgi-bin', ['cgi-bin/roundup.cgi']),
-    ] 
+    py_modules = ['roundup.demo',]
 
+    # build list of scripts from their implementation modules
+    scripts = [scriptname(f) for f in glob('roundup/scripts/[!_]*.py')]
+
+    data_files = [
+        ('share/roundup/cgi-bin', ['frontends/roundup.cgi']),
+    ]
     # install man pages on POSIX platforms
     if os.name == 'posix':
-        installdatafiles.append(('man/man1', ['doc/roundup-admin.1',
-            'doc/roundup-mailgw.1', 'doc/roundup-server.1']))
+        data_files.append(include('share/man/man1', '*'))
 
     # add the templates to the data files lists
     from roundup.init import listTemplates
-    templates = [t['path'] for t in listTemplates('templates').values()]
+    templates = [t['path']
+                 for t in listTemplates('share/roundup/templates').values()]
     for tdir in templates:
-        # scan for data files
-        for idir in '. detectors html'.split():
-            idir = os.path.join(tdir, idir)
-            tfiles = []
-            for f in os.listdir(idir):
-                if f.startswith('.'):
-                    continue
-                ifile = os.path.join(idir, f)
-                if os.path.isfile(ifile):
-                    tfiles.append(ifile)
-            installdatafiles.append(
-                (os.path.join('share', 'roundup', idir), tfiles)
-            )
+        for idir in '. detectors extensions html'.split():
+            data_files.append(include(os.path.join(tdir, idir), '*'))
+
+    # add message files
+    for (_dist_file, _mo_file) in list_message_files():
+        data_files.append((os.path.dirname(_mo_file),
+                           [os.path.join("build", _mo_file)]))
+
+    # add docs
+    data_files.append(include('share/doc/roundup/html', '*'))
 
     # perform the setup action
     from roundup import __version__
-    setup(
-        name = "roundup", 
-        version = __version__,
-        description = "A simple-to-use and -install issue-tracking system"
+
+    # long_description may not contain non-ascii characters. Distutils
+    # will produce an non-installable installer on linux *and* we can't
+    # run the bdist_wininst on Linux if there are non-ascii characters
+    # because the distutils installer will try to use the mbcs codec
+    # which isn't available on non-windows platforms. See also
+    # http://bugs.python.org/issue10945
+    long_description=open('doc/announcement.txt').read().decode('utf8')
+    try:
+        long_description = long_description.encode('ascii')
+    except UnicodeEncodeError, cause:
+        print >> sys.stderr, "doc/announcement.txt contains non-ascii: %s" \
+            % cause
+        sys.exit(42)
+
+    setup(name='roundup',
+          version=__version__,
+          author="Richard Jones",
+          author_email="richard@users.sourceforge.net",
+          description="A simple-to-use and -install issue-tracking system"
             " with command-line, web and e-mail interfaces. Highly"
             " customisable.",
-        long_description = 
-'''Roundup is a simple-to-use and -install issue-tracking system with
-command-line, web and e-mail interfaces. It is based on the winning design
-from Ka-Ping Yee in the Software Carpentry "Track" design competition.
-
-If you're upgrading from an older version of Roundup you *must* follow
-the "Software Upgrade" guidelines given in the maintenance documentation.
-
-No, really, this is a BETA and if you don't follow the upgrading steps,
-particularly the bit about BACKING UP YOUR DATA, I'm NOT GOING TO BE HELD
-RESPONSIBLE. This release is NOT FOR GENERAL USE.
-
-I would *greatly* appreciate people giving this release a whirl with a
-copy of their existing setup. It's only through real-world testing of
-beta releases that we can ensure that older trackers will be OK.
-
-This release introduces far too many features to list here. Some
-highlights:
-
-- added postgresql backend (originally from sf patch 761740, many changes
-  since)
-- RDBMS backends implement their session and one-time-key stores and
-  full-text indexers; thus they are now performing their own locking
-  internally
-- added new "actor" automatic property (indicates user who cause the last
-  "activity")
-- all RDBMS backends have sensible data typed columns and indexes on
-  several columns
-- we support confirming registration by replying to the email (sf bug
-  763668)
-- all HTML templating methods now automatically check for permissions
-  (either view or edit as appropriate), greatly simplifying templates
-''',
-        author = "Richard Jones",
-        author_email = "richard@users.sourceforge.net",
-        url = 'http://roundup.sourceforge.net/',
-        download_url = 'http://sourceforge.net/project/showfiles.php?group_id=31577',
-        packages = packagelist,
-        classifiers = [
-            'Development Status :: 4 - Beta',
-            'Environment :: Console',
-            'Environment :: Web Environment',
-            'Intended Audience :: End Users/Desktop',
-            'Intended Audience :: Developers',
-            'Intended Audience :: System Administrators',
-            'License :: OSI Approved :: Python Software Foundation License',
-            'Operating System :: MacOS :: MacOS X',
-            'Operating System :: Microsoft :: Windows',
-            'Operating System :: POSIX',
-            'Programming Language :: Python',
-            'Topic :: Communications :: Email',
-            'Topic :: Office/Business',
-            'Topic :: Software Development :: Bug Tracking',
-        ],
-
-        # Override certain command classes with our own ones
-        cmdclass = {
-            'build_scripts': build_scripts_roundup,
-            'build': build_roundup,
-        },
-        scripts = roundup_scripts,
-
-        data_files =  installdatafiles
-    )
+          long_description=long_description,
+          url='http://www.roundup-tracker.org',
+          download_url='http://pypi.python.org/pypi/roundup',
+          classifiers=['Development Status :: 5 - Production/Stable',
+                       'Environment :: Console',
+                       'Environment :: Web Environment',
+                       'Intended Audience :: End Users/Desktop',
+                       'Intended Audience :: Developers',
+                       'Intended Audience :: System Administrators',
+                       'License :: OSI Approved :: Python Software Foundation License',
+                       'Operating System :: MacOS :: MacOS X',
+                       'Operating System :: Microsoft :: Windows',
+                       'Operating System :: POSIX',
+                       'Programming Language :: Python',
+                       'Topic :: Communications :: Email',
+                       'Topic :: Office/Business',
+                       'Topic :: Software Development :: Bug Tracking',
+                       ],
+
+          # Override certain command classes with our own ones
+          cmdclass= {'build_doc': build_doc,
+                     'build_scripts': build_scripts,
+                     'build_py': build_py,
+                     'build': build,
+                     'bdist_rpm': bdist_rpm,
+                     'install_lib': install_lib,
+                     },
+          packages=packages,
+          py_modules=py_modules,
+          scripts=scripts,
+          data_files=data_files)
 
 if __name__ == '__main__':
     main()
 
-# vim: set filetype=python ts=4 sw=4 et si
+# vim: set filetype=python sts=4 sw=4 et si :