setup.py

   1 #! /usr/bin/env python
   2 #
   3 # Copyright (c) 2001 Bizar Software Pty Ltd (http://www.bizarsoftware.com.au/)
   4 # This module is free software, and you may redistribute it and/or modify
   5 # under the same terms as Python, so long as this copyright message and
   6 # disclaimer are retained in their original form.
   7 #
   8 # IN NO EVENT SHALL BIZAR SOFTWARE PTY LTD BE LIABLE TO ANY PARTY FOR
   9 # DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING
  10 # OUT OF THE USE OF THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE
  11 # POSSIBILITY OF SUCH DAMAGE.
  12 #
  13 # BIZAR SOFTWARE PTY LTD SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  14 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  15 # FOR A PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
  16 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
  17 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  18 #
  19
  20
  21 from roundup.dist.command.build_doc import build_doc
  22 from roundup.dist.command.build_scripts import build_scripts
  23 from roundup.dist.command.build_py import build_py
  24 from roundup.dist.command.build import build, list_message_files
  25 from roundup.dist.command.bdist_rpm import bdist_rpm
  26 from distutils.core import setup
  27
  28 import sys, os
  29 from glob import glob
  30
  31 # patch distutils if it can't cope with the "classifiers" keyword
  32 from distutils.dist import DistributionMetadata
  33 if not hasattr(DistributionMetadata, 'classifiers'):
  34     DistributionMetadata.classifiers = None
  35     DistributionMetadata.download_url = None
  36
  37 def include(d, e):
  38     """Generate a pair of (directory, file-list) for installation.
  39
  40     'd' -- A directory
  41
  42     'e' -- A glob pattern"""
  43
  44     return (d, [f for f in glob('%s/%s'%(d, e)) if os.path.isfile(f)])
  45
  46 def scriptname(path):
  47     """ Helper for building a list of script names from a list of
  48         module files.
  49     """
  50     script = os.path.splitext(os.path.basename(path))[0]
  51     script = script.replace('_', '-')
  52     return script
  53
  54 def main():
  55     # template munching
  56     packages = [
  57         'roundup',
  58         'roundup.anypy',
  59         'roundup.cgi',
  60         'roundup.cgi.PageTemplates',
  61         'roundup.cgi.TAL',
  62         'roundup.cgi.ZTUtils',
  63         'roundup.backends',
  64         'roundup.scripts',
  65     ]
  66     py_modules = ['roundup.demo',]
  67
  68     # build list of scripts from their implementation modules
  69     scripts = [scriptname(f) for f in glob('roundup/scripts/[!_]*.py')]
  70
  71     data_files = [
  72         ('share/roundup/cgi-bin', ['frontends/roundup.cgi']),
  73     ]
  74     # install man pages on POSIX platforms
  75     if os.name == 'posix':
  76         data_files.append(include('share/man/man1', '*'))
  77
  78     # add the templates to the data files lists
  79     from roundup.init import listTemplates
  80     templates = [t['path']
  81                  for t in listTemplates('share/roundup/templates').values()]
  82     for tdir in templates:
  83         for idir in '. detectors extensions html'.split():
  84             data_files.append(include(os.path.join(tdir, idir), '*'))
  85
  86     # add message files
  87     for (_dist_file, _mo_file) in list_message_files():
  88         data_files.append((os.path.dirname(_mo_file),
  89                            [os.path.join("build", _mo_file)]))
  90
  91     # add docs
  92     data_files.append(include('share/doc/roundup/html', '*'))
  93
  94     # perform the setup action
  95     from roundup import __version__
  96
  97     setup(name='roundup',
  98           version=__version__,
  99           author="Richard Jones",
 100           author_email="richard@users.sourceforge.net",
 101           description="A simple-to-use and -install issue-tracking system"
 102             " with command-line, web and e-mail interfaces. Highly"
 103             " customisable.",
 104           long_description='''In this release
 105 ===============
 106
 107 1.4.7 is primarily a bugfix release which contains important security
 108 fixes:
 109
 110 - a number of security issues were discovered by Daniel Diniz
 111 - EditCSV and ExportCSV altered to include permission checks
 112 - HTTP POST required on actions which alter data
 113 - HTML file uploads served as application/octet-stream
 114 - Handle Unauthorised in file serving correctly
 115 - New item action reject creation of new users
 116 - Item retirement was not being controlled
 117 - Roundup is now compatible with Python 2.6
 118 - Improved French and German translations
 119 - Improve consistency of item sorting in HTML interface
 120 - Various other small bug fixes, robustification and optimisation
 121
 122 Though some new features made it in also:
 123
 124 - Provide a "no selection" option in web interface selection widgets
 125 - Debug logging now uses the logging module rather than print
 126 - Allow CGI frontend to serve XMLRPC requests.
 127 - Added XMLRPC actions, as well as bridging CGI actions to XMLRPC actions.
 128 - Optimized large file serving via mod_python / sendfile().
 129 - Support resuming downloads for (large) files.
 130
 131 If you're upgrading from an older version of Roundup you *must* follow
 132 the "Software Upgrade" guidelines given in the maintenance documentation.
 133
 134 Roundup requires python 2.3 or later for correct operation.
 135
 136 To give Roundup a try, just download (see below), unpack and run::
 137
 138     roundup-demo
 139
 140 Documentation is available at the website:
 141      http://roundup.sourceforge.net/
 142 Mailing lists - the place to ask questions:
 143      http://sourceforge.net/mail/?group_id=31577
 144
 145 About Roundup
 146 =============
 147
 148 Roundup is a simple-to-use and -install issue-tracking system with
 149 command-line, web and e-mail interfaces. It is based on the winning design
 150 from Ka-Ping Yee in the Software Carpentry "Track" design competition.
 151
 152 Note: Ping is not responsible for this project. The contact for this
 153 project is richard@users.sourceforge.net.
 154
 155 Roundup manages a number of issues (with flexible properties such as
 156 "description", "priority", and so on) and provides the ability to:
 157
 158 (a) submit new issues,
 159 (b) find and edit existing issues, and
 160 (c) discuss issues with other participants.
 161
 162 The system will facilitate communication among the participants by managing
 163 discussions and notifying interested parties when issues are edited. One of
 164 the major design goals for Roundup that it be simple to get going. Roundup
 165 is therefore usable "out of the box" with any python 2.3+ installation. It
 166 doesn't even need to be "installed" to be operational, though a
 167 disutils-based install script is provided.
 168
 169 It comes with two issue tracker templates (a classic bug/feature tracker and
 170 a minimal skeleton) and five database back-ends (anydbm, sqlite, metakit,
 171 mysql and postgresql).
 172 ''',
 173           url='http://www.roundup-tracker.org',
 174           download_url='http://pypi.python.org/pypi/roundup',
 175           classifiers=['Development Status :: 5 - Production/Stable',
 176                        'Environment :: Console',
 177                        'Environment :: Web Environment',
 178                        'Intended Audience :: End Users/Desktop',
 179                        'Intended Audience :: Developers',
 180                        'Intended Audience :: System Administrators',
 181                        'License :: OSI Approved :: Python Software Foundation License',
 182                        'Operating System :: MacOS :: MacOS X',
 183                        'Operating System :: Microsoft :: Windows',
 184                        'Operating System :: POSIX',
 185                        'Programming Language :: Python',
 186                        'Topic :: Communications :: Email',
 187                        'Topic :: Office/Business',
 188                        'Topic :: Software Development :: Bug Tracking',
 189                        ],
 190
 191           # Override certain command classes with our own ones
 192           cmdclass= {'build_doc': build_doc,
 193                      'build_scripts': build_scripts,
 194                      'build_py': build_py,
 195                      'build': build,
 196                      'bdist_rpm': bdist_rpm,
 197                      },
 198           packages=packages,
 199           py_modules=py_modules,
 200           scripts=scripts,
 201           data_files=data_files)
 202
 203 if __name__ == '__main__':
 204     main()
 205
 206 # vim: set filetype=python sts=4 sw=4 et si :