Code

- update with possible tracker issue
[roundup.git] / setup.py
index 800603e61903817a2db4eefc82788b831965b1a8..c2589f11850d66d29dbda17943aec83c9f6bfe36 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.41 2002-12-10 00:11:13 richard Exp $
+#
+
 
-from distutils.core import setup, Extension
-from distutils.util import get_platform
-from distutils.command.build_scripts import build_scripts
+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 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
-if sys.version < '2.2.3':
-    from distutils.dist import DistributionMetadata
+from distutils.dist import DistributionMetadata
+if not hasattr(DistributionMetadata, 'classifiers'):
     DistributionMetadata.classifiers = None
+    DistributionMetadata.download_url = None
 
-from roundup.templates.builder import makeHtmlBase
-
-
-#############################################################################
-### Build script files
-#############################################################################
+def include(d, e):
+    """Generate a pair of (directory, file-list) for installation.
 
-class build_scripts_create(build_scripts):
-    """ Overload the build_scripts command and create the scripts
-        from scratch, depending on the target platform.
+    'd' -- A directory
 
-        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" -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'
-                        '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
 
-
-
-#############################################################################
-### 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', '*'))))
-
-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'))
-
+def main():
     # template munching
-    templates = map(os.path.basename, filter(isTemplateDir,
-        glob(os.path.join('roundup', 'templates', '*'))))
-    packagelist = [
+    packages = [
         'roundup',
+        'roundup.anypy',
         '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)
+    py_modules = ['roundup.demo',]
 
-        # add the template package and subpackage
-        packagelist.append('roundup.templates.%s' % template)
-        packagelist.append('roundup.templates.%s.detectors' % template)
+    # build list of scripts from their implementation modules
+    scripts = [scriptname(f) for f in glob('roundup/scripts/[!_]*.py')]
 
-        # 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)
-        )
+    data_files = [
+        ('share/roundup/cgi-bin', ['frontends/roundup.cgi']),
+    ]
+    # install man pages on POSIX platforms
+    if os.name == 'posix':
+        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('share/roundup/templates').values()]
+    for tdir in templates:
+        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 = "Roundup issue tracking system.",
-        author = "Richard Jones",
-        author_email = "richard@users.sourceforge.net",
-        url = 'http://sourceforge.net/projects/roundup/',
-        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,
-        },
-        scripts = roundup_scripts,
-
-        data_files =  installdatafiles
-    )
-
-# vim: set filetype=python ts=4 sw=4 et si
+
+    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='''This version of Roundup fixes some bugs:
+
+- Minor update of doc/developers.txt to point to the new resources
+  on www.roundup-tracker.org (Bernhard Reiter)
+- Small CSS improvements regaring the search box (thanks Thomas Arendsan Hein)
+  (issue 2550589)
+- Indexers behaviour made more consistent regarding length of indexed words
+  and stopwords (thanks Thomas Arendsen Hein, Bernhard Reiter)(issue 2550584)
+- fixed typos in the installation instructions (thanks Thomas Arendsen Hein)
+  (issue 2550573) 
+- New config option csv_field_size: Pythons csv module (which is used
+  for export/import) has a new field size limit starting with python2.5.
+  We now issue a warning during export if the limit is too small and use
+  the csv_field_size configuration during import to set the limit for
+  the csv module.
+- Small fix for CGI-handling of XMLRPC requests for python2.4, this
+  worked only for 2.5 and beyond due to a change in the xmlrpc interface
+  in python
+- Document filter method of xmlrpc interface
+- Fix interaction of SSL and XMLRPC, now XMLRPC works with SSL
+
+If you're upgrading from an older version of Roundup you *must* follow
+the "Software Upgrade" guidelines given in the maintenance documentation.
+
+Roundup requires python 2.3 or later (but not 3+) for correct operation.
+
+To give Roundup a try, just download (see below), unpack and run::
+
+    roundup-demo
+
+Documentation is available at the website:
+     http://roundup.sourceforge.net/
+Mailing lists - the place to ask questions:
+     http://sourceforge.net/mail/?group_id=31577
+
+About Roundup
+=============
+
+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.
+
+Note: Ping is not responsible for this project. The contact for this
+project is richard@users.sourceforge.net.
+
+Roundup manages a number of issues (with flexible properties such as
+"description", "priority", and so on) and provides the ability to:
+
+(a) submit new issues,
+(b) find and edit existing issues, and
+(c) discuss issues with other participants.
+
+The system will facilitate communication among the participants by managing
+discussions and notifying interested parties when issues are edited. One of
+the major design goals for Roundup that it be simple to get going. Roundup
+is therefore usable "out of the box" with any python 2.3+ (but not 3+)
+installation. It doesn't even need to be "installed" to be operational,
+though an install script is provided.
+
+It comes with two issue tracker templates (a classic bug/feature tracker and
+a minimal skeleton) and five database back-ends (anydbm, sqlite, metakit,
+mysql and postgresql).
+''',
+          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,
+                     },
+          packages=packages,
+          py_modules=py_modules,
+          scripts=scripts,
+          data_files=data_files)
+
+if __name__ == '__main__':
+    main()
+
+# vim: set filetype=python sts=4 sw=4 et si :