Code

Fix mailer (sf bug #817470) and add docstrings to prevent this from happening again.
[roundup.git] / setup.py
index 29f75ca1ce7d7ad04d22c904cde1bf8256d32b43..70918726f4c8c7e3ad35adf796ceaf8f929476a7 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -16,7 +16,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: setup.py,v 1.31 2002-03-22 18:36:00 jhermann Exp $
+# $Id: setup.py,v 1.56 2003-08-18 06:31:59 richard Exp $
 
 from distutils.core import setup, Extension
 from distutils.util import get_platform
@@ -25,7 +25,11 @@ from distutils.command.build_scripts import build_scripts
 import sys, os, string
 from glob import glob
 
-from roundup.templatebuilder import makeHtmlBase
+# patch distutils if it can't cope with the "classifiers" keyword
+from distutils.dist import DistributionMetadata
+if not hasattr(DistributionMetadata, 'classifiers'):
+    DistributionMetadata.classifiers = None
+    DistributionMetadata.download_url = None
 
 
 #############################################################################
@@ -73,10 +77,22 @@ class build_scripts_create(build_scripts):
 
             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)
@@ -85,10 +101,11 @@ class build_scripts_create(build_scripts):
             try:
                 if sys.platform == "win32":
                     file.write('@echo off\n'
-                        '%(python)s -c "from %(package)s.scripts.%(module)s import run; run()" %%$\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\n'
+                    file.write('#! %(python)s -O\n%(prefix)s'
                         'from %(package)s.scripts.%(module)s import run\n'
                         'run()\n'
                         % script_vars)
@@ -111,157 +128,122 @@ def scriptname(path):
         script = script + ".bat"
     return script
 
-# build list of scripts from their implementation modules
-roundup_scripts = map(scriptname, glob('roundup/scripts/[!_]*.py'))
 
 
 #############################################################################
 ### 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'))
-
-templates = map(os.path.basename, filter(isTemplateDir,
-    glob(os.path.join('roundup', 'templates', '*'))))
-packagelist = [
-    'roundup',
-    'roundup.backends',
-    'roundup.scripts',
-    '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 main():
+    # build list of scripts from their implementation modules
+    roundup_scripts = map(scriptname, glob('roundup/scripts/[!_]*.py'))
+
+    # template munching
+    packagelist = [
+        'roundup',
+        'roundup.cgi',
+        'roundup.cgi.PageTemplates',
+        'roundup.cgi.TAL',
+        'roundup.cgi.ZTUtils',
+        'roundup.backends',
+        'roundup.scripts'
+    ]
+    installdatafiles = [
+        ('share/roundup/cgi-bin', ['cgi-bin/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']))
+
+    # add the templates to the data files lists
+    from roundup.admin import listTemplates
+    templates = [t['path'] for t in listTemplates('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)
+            )
+
+    # perform the setup action
+    from roundup import __version__
+    setup(
+        name = "roundup", 
+        version = __version__,
+        description = "Roundup issue tracking system.",
+        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.
+
+The 0.6 release has lots of new goodies including:
+
+- new instant-gratification Demo Mode ("python demo.py" :)
+- added mysql backend (see doc/mysql.txt for details)
+- web interface cleanups including nicer history display, nicer index
+  navigation and nicer popup list windows
+- searching of date ranges
+- better international support, including utf-8 email handling and ability
+  to display localized dates in web interface.
+- more documentation including revamped design document, unix manual pages
+  and some FAQ entries
+- significantly more powerful form handling allowing editing of multiple
+  items and creation of multiple items
+- tracker templates can contain subdirectories and static files (e.g.
+  images) and we may now distribute templates separately from Roundup.
+  Template HTML files now have a .html extension too.
+- user registration is now a two-step process, with confirmation from the
+  email address supplied in the registration form, and we also have a
+  password reset feature for forgotten password / login
+- Windows Service mode for roundup-server when daemonification is
+  attempted on Windows
+- lots of speed enhancements, making the web interface much more responsive
+- fixed issues with dumb email or web clients
+- email system handles more SMTP and POP features (TLS, APOP, ...)
+- lots more little tweaks and back-end work...
+''',
+        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 :: 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_scripts': build_scripts_roundup,
+        },
+        scripts = roundup_scripts,
+
+        data_files =  installdatafiles
     )
 
+if __name__ == '__main__':
+    main()
 
-setup(
-    name = "roundup", 
-    version = "0.4.0",
-    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.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
-#
-# Revision 1.26  2001/12/08 07:06:20  jhermann
-# Install html template files to share/roundup/templates
-#
-# Revision 1.25  2001/11/21 23:42:54  richard
-# Some version number and documentation fixes.
-#
-# Revision 1.24  2001/11/06 22:32:15  jhermann
-# Install roundup.cgi to share/roundup
-#
-# Revision 1.23  2001/10/17 06:04:00  richard
-# Beginnings of an interactive mode for roundup-admin
-#
-# Revision 1.22  2001/10/11 05:01:28  richard
-# Prep for pre-release #2
-#
-# Revision 1.21  2001/10/10 04:18:38  richard
-# Getting ready for a preview release for 0.3.0.
-#
-# Revision 1.20  2001/10/08 21:49:30  richard
-# Minor pre- 0.3.0 changes
-#
-# Revision 1.19  2001/09/10 09:48:35  richard
-# Started changes log for 0.2.9
-#
-# Revision 1.18  2001/08/30 06:01:17  richard
-# Fixed missing import in mailgw :(
-#
-# Revision 1.17  2001/08/08 03:29:35  richard
-# Next release is 0.2.6
-#
-# Revision 1.16  2001/08/07 00:24:42  richard
-# stupid typo
-#
-# Revision 1.15  2001/08/07 00:15:51  richard
-# Added the copyright/license notice to (nearly) all files at request of
-# Bizar Software.
-#
-# Revision 1.14  2001/08/06 23:57:20  richard
-# Am now bundling unittest with the package so that everyone can use the unit
-# tests.
-#
-# Revision 1.13  2001/08/03 07:18:57  richard
-# updated version number for 0.2.6
-#
-# Revision 1.12  2001/08/03 02:51:06  richard
-# detect unit tests
-#
-# Revision 1.11  2001/08/03 01:54:58  richard
-# Started stuff off for the 0.2.5 release
-#
-# Revision 1.10  2001/07/30 07:17:44  richard
-# Just making sure we've got the right version in there for development.
-#
-# Revision 1.9  2001/07/29 23:34:26  richard
-# Added unit tests so they're run whenever we package/install/whatever.
-#
-# Revision 1.8  2001/07/29 09:43:46  richard
-# Make sure that the htmlbase is up-to-date when we build a source dist.
-#
-# Revision 1.7  2001/07/29 08:37:58  richard
-# changes
-#
-# Revision 1.6  2001/07/29 07:01:39  richard
-# Added vim command to all source so that we don't get no steenkin' tabs :)
-#
-# Revision 1.5  2001/07/28 00:39:18  richard
-# changes for the 0.2.1 distribution build.
-#
-# Revision 1.4  2001/07/27 07:20:17  richard
-# Makefile is now obsolete - setup does what it used to do.
-#
-# Revision 1.3  2001/07/27 06:56:25  richard
-# Added scripts to the setup and added the config so the default script
-# install dir is /usr/local/bin.
-#
-# Revision 1.2  2001/07/26 07:14:27  richard
-# Made setup.py executable, added id and log.
-#
-#
-#
 # vim: set filetype=python ts=4 sw=4 et si