]> git.rkrishnan.org Git - tahoe-lafs/zfec.git/blobdiff - zfec/setup.py
add exceptions to GPL and TGPPL to allow derivative works containing parts under...
[tahoe-lafs/zfec.git] / zfec / setup.py
index 3684b6d3886d28de364de33d3393b63b62dd96c6..8a1a5b389be584bd088408e6f452c2334c70243d 100755 (executable)
@@ -1,34 +1,17 @@
-#!/usr/bin/env python
-
+
 # zfec -- fast forward error correction library with Python interface
-# 
-# Copyright (C) 2007-2009 Allmydata, Inc.
-# Author: Zooko Wilcox-O'Hearn
-# 
+#
+# copyright © 2007-2013 Zooko Wilcox-O'Hearn
+#
 # This file is part of zfec.
 #
-# See README.txt for licensing information.
+# See README.rst for licensing information.
 
-import os, re, sys
+import glob, os, re, sys
 
-miscdeps=os.path.join(os.getcwd(), 'misc', 'dependencies')
-
-try:
-    from ez_setup import use_setuptools
-except ImportError:
-    pass
-else:
-    # 0.6c7 on Windows and 0.6c6 on Ubuntu had a problem with multiple
-    # overlapping dependencies on pyutil -- it would end up with the 'pyutil'
-    # key set in sys.modules but the actual code (and the temporary directory
-    # in the filesystem in which the code used to reside) gone, when it needed
-    # pyutil again later.
-    # On cygwin there was a conflict with swig with setuptools 0.6c7:
-    #   File "/home/Buildslave/windows-cygwin-pycryptopp/windows-cygwin/build/misc/dependencies/setuptools-0.6c7.egg/setuptools/command/build_ext.py", line 77, in swig_sources
-    # TypeError: swig_sources() takes exactly 3 arguments (2 given)
-    # If there isn't a setuptools already installed, then this will install
-    # setuptools v0.6c12dev (which is our own toothpick of setuptools).
-    use_setuptools(download_delay=0, min_version="0.6c12dev")
+egg = os.path.realpath(glob.glob('setuptools-*.egg')[0])
+sys.path.insert(0, egg)
+import setuptools; setuptools.bootstrap_install_from = egg
 
 from setuptools import Extension, find_packages, setup
 
@@ -63,10 +46,10 @@ if DEBUGMODE:
 trove_classifiers=[
     "Development Status :: 5 - Production/Stable",
     "Environment :: Console",
-    "License :: OSI Approved :: GNU General Public License (GPL)", 
+    "License :: OSI Approved :: GNU General Public License (GPL)", # See README.rst for alternative licensing.
     "License :: DFSG approved",
     "License :: Other/Proprietary License",
-    "Intended Audience :: Developers", 
+    "Intended Audience :: Developers",
     "Intended Audience :: End Users/Desktop",
     "Intended Audience :: System Administrators",
     "Operating System :: Microsoft",
@@ -76,22 +59,24 @@ trove_classifiers=[
     "Operating System :: POSIX",
     "Operating System :: MacOS :: MacOS X",
     "Operating System :: Microsoft :: Windows :: Windows NT/2000",
-    "Operating System :: OS Independent", 
-    "Natural Language :: English", 
-    "Programming Language :: C", 
+    "Operating System :: OS Independent",
+    "Natural Language :: English",
+    "Programming Language :: C",
     "Programming Language :: Python", 
     "Programming Language :: Python :: 2",
     "Programming Language :: Python :: 2.4",
     "Programming Language :: Python :: 2.5",
+    "Programming Language :: Python :: 2.6",
+    "Programming Language :: Python :: 2.7",
     "Topic :: Utilities",
     "Topic :: System :: Systems Administration",
     "Topic :: System :: Filesystems",
     "Topic :: System :: Distributed Computing",
     "Topic :: Software Development :: Libraries",
     "Topic :: Communications :: Usenet News",
-    "Topic :: System :: Archiving :: Backup", 
-    "Topic :: System :: Archiving :: Mirroring", 
-    "Topic :: System :: Archiving", 
+    "Topic :: System :: Archiving :: Backup",
+    "Topic :: System :: Archiving :: Mirroring",
+    "Topic :: System :: Archiving",
     ]
 
 PKG = "zfec"
@@ -110,52 +95,90 @@ else:
         print "unable to find version in %s" % (VERSIONFILE,)
         raise RuntimeError("if %s.py exists, it is required to be well-formed" % (VERSIONFILE,))
 
-dependency_links=[os.path.join(miscdeps, t) for t in os.listdir(miscdeps) if t.endswith(".tar")]
 setup_requires = []
+tests_require = []
+
+tests_require.append("pyutil >= 1.3.19")
 
-# The darcsver command from the darcsver plugin is needed to initialize the
-# distribution's .version attribute correctly. (It does this either by
-# examining darcs history, or if that fails by reading the
-# zfec/_version.py file). darcsver will also write a new version
-# stamp in zfec/_version.py, with a version number derived from
-# darcs history. Note that the setup.cfg file has an "[aliases]" section
-# which enumerates commands that you might run and specifies that it will run
-# darcsver before each one. If you add different commands (or if I forgot
-# some that are already in use), you may need to add it to setup.cfg and
-# configure it to run darcsver before your command, if you want the version
-# number to be correct when that command runs.
-# http://pypi.python.org/pypi/darcsver
-setup_requires.append('darcsver >= 1.2.0')
-
-# setuptools_darcs is required to produce complete distributions (such as with
-# "sdist" or "bdist_egg"), unless there is a zfec.egg-info/SOURCE.txt file
-# present which contains a complete list of files that should be included.
+# darcsver is needed only if you want "./setup.py darcsver" to write a new
+# version stamp in pyutil/_version.py, with a version number derived from
+# darcs history.  http://pypi.python.org/pypi/darcsver
+if 'darcsver' in sys.argv[1:]:
+    setup_requires.append('darcsver >= 1.0.0')
+
+# setuptools_darcs is required to produce complete distributions (such
+# as with "sdist" or "bdist_egg"), unless there is a
+# zfec.egg-info/SOURCE.txt file present which contains a complete
+# list of files that should be included.
 # http://pypi.python.org/pypi/setuptools_darcs
-setup_requires.append('setuptools_darcs >= 1.1.0')
+
+# However, requiring it runs afoul of a bug in Distribute, which was
+# shipped in Ubuntu Lucid, so for now you have to manually install it
+# before building sdists or eggs:
+# http://bitbucket.org/tarek/distribute/issue/55/revision-control-plugin-automatically-installed-as-a-build-dependency-is-not-present-when-another-build-dependency-is-being
+if False:
+    setup_requires.append('setuptools_darcs >= 1.1.0')
+
+
+# setuptools_trial is needed if you want "./setup.py trial" or
+# "./setup.py test" to execute the tests.
+# http://pypi.python.org/pypi/setuptools_trial
+if 'trial' in sys.argv[1:]:
+    setup_requires.extend(['setuptools_trial >= 0.5'])
+
+# trialcoverage is required if you want the "trial" unit test runner to have a
+# "--reporter=bwverbose-coverage" option which produces code-coverage results.
+if "--reporter=bwverbose-coverage" in sys.argv:
+    tests_require.append('trialcoverage >= 0.3.3')
+    tests_require.append('twisted >= 2.4.0')
+    tests_require.append('setuptools_trial >= 0.5')
 
 # stdeb is required to build Debian dsc files.
 if "sdist_dsc" in sys.argv:
     setup_requires.append('stdeb')
 
-data_fnames=[ 'COPYING.GPL', 'changelog', 'COPYING.TGPPL.html', 'TODO', 'README.txt' ]
+data_fnames=[ 'COPYING.GPL', 'changelog', 'COPYING.TGPPL.rst', 'TODO', 'README.rst' ]
 
 # In case we are building for a .deb with stdeb's sdist_dsc command, we put the
 # docs in "share/doc/$PKG".
 doc_loc = "share/doc/" + PKG
 data_files = [(doc_loc, data_fnames)]
 
-def _setup(test_suite):
+readmetext = open('README.rst').read()
+if readmetext[:3] == '\xef\xbb\xbf':
+    # utf-8 "BOM"
+    readmetext = readmetext[3:]
+
+try:
+    readmetext = readmetext.decode('utf-8')
+except UnicodeDecodeError:
+    pass
+
+install_requires=["pyutil >= 1.3.19"]
+
+# argparse comes built into Python >= 2.7, and is provided by the "argparse"
+# distribution for earlier versions of Python.
+try:
+    import argparse
+    argparse # hush pyflakes
+except ImportError:
+    install_requires.append("argparse >= 0.8")
+
+# distutils in Python 2.4 has a bug in that it tries to encode the long
+# description into ascii. We detect the resulting exception and try again
+# after squashing the long description (lossily) into ascii.
+
+def _setup(longdescription):
     setup(name=PKG,
           version=verstr,
           description='a fast erasure codec which can be used with the command-line, C, Python, or Haskell',
-          long_description='Fast, portable, programmable erasure coding a.k.a. "forward error correction": the generation of redundant blocks of information such that if some blocks are lost then the original data can be recovered from the remaining blocks.  The zfec package includes command-line tools, C API, Python API, and Haskell API',
+          long_description=longdescription,
           author='Zooko O\'Whielacronx',
           author_email='zooko@zooko.com',
-          url='http://allmydata.org/trac/'+PKG,
-          license='GNU GPL',
-          dependency_links=dependency_links,
-          install_requires=["argparse >= 0.8", "pyutil >= 1.3.19"],
-          tests_require=["pyutil >= 1.3.19"],
+          url='https://tahoe-lafs.org/trac/'+PKG,
+          license='GNU GPL', # See README.rst for alternative licensing.
+          install_requires=install_requires,
+          tests_require=tests_require,
           packages=find_packages(),
           include_package_data=True,
           data_files=data_files,
@@ -163,17 +186,14 @@ def _setup(test_suite):
           classifiers=trove_classifiers,
           entry_points = { 'console_scripts': [ 'zfec = %s.cmdline_zfec:main' % PKG, 'zunfec = %s.cmdline_zunfec:main' % PKG ] },
           ext_modules=[Extension(PKG+'._fec', [PKG+'/fec.c', PKG+'/_fecmodule.c',], extra_link_args=extra_link_args, extra_compile_args=extra_compile_args, undef_macros=undef_macros, define_macros=define_macros),],
-          test_suite=test_suite,
+          test_suite=PKG+".test",
           zip_safe=False, # I prefer unzipped for easier access.
+          extras_require={
+            'ed25519=ba95497adf4db8e17f688c0979003c48c76897d60e2d2193f938b9ab62115f59':[],
+            },
           )
 
-test_suite_name=PKG+".test"
 try:
-    _setup(test_suite=test_suite_name)
-except Exception, le:
-    # to work around a bug in Elisa v0.3.5
-    # https://bugs.launchpad.net/elisa/+bug/263697
-    if "test_suite must be a list" in str(le):
-        _setup(test_suite=[test_suite_name])
-    else:
-        raise
+    _setup(readmetext)
+except UnicodeEncodeError:
+    _setup(repr(readmetext))