Code

- Actually use FormError, so we can move the handling of this exception up to
[roundup.git] / setup.py
index 4dc866b232a5612e7e138e34ab5d7430976ad8ea..70918726f4c8c7e3ad35adf796ceaf8f929476a7 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -5,7 +5,7 @@
 # under the same terms as Python, so long as this copyright message and
 # disclaimer are retained in their original form.
 #
-# IN NO EVENT SHALL THE BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
+# IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: setup.py,v 1.15 2001-08-07 00:15:51 richard 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
+from distutils.command.build_scripts import build_scripts
 
+import sys, os, string
 from glob import glob
-import os
-from roundup.templatebuilder import makeHtmlBase
 
-print 'Running unit tests...'
-import test
-test.go()
+# 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
 
-templates = 'classic', 'extended'
-packagelist = [ 'roundup', 'roundup.backends', 'roundup.templates' ]
-installdatafiles = []
 
-for t in templates:
-    makeHtmlBase(os.path.join('roundup', 'templates', t))
-    packagelist.append('roundup.templates.%s'%t)
-    packagelist.append('roundup.templates.%s.detectors'%t)
-    tfiles = glob(os.path.join('roundup','templates', t, 'html', '*'))
-    tfiles = filter(os.path.isfile, tfiles)
+#############################################################################
+### 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.
 
-setup ( name = "roundup", 
-        version = "0.2.6",
+        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)
+            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'
+
+
+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 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@sourceforge.net",
-        url = 'http://sourceforge.net/projects/roundup/',
+        author_email = "richard@users.sourceforge.net",
+        url = 'http://roundup.sourceforge.net/',
+        download_url = 'http://sourceforge.net/project/showfiles.php?group_id=31577',
         packages = packagelist,
-        scripts = ['roundup-admin', 'roundup-mailgw', 'roundup-server']
-)
+        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()
 
-#
-# $Log: not supported by cvs2svn $
-# 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