]> git.rkrishnan.org Git - tahoe-lafs/zfec.git/blobdiff - zfec/setup.py
setup: loosen the requirements -- you need argparse and pyutil only if you want the...
[tahoe-lafs/zfec.git] / zfec / setup.py
index 7c39d090a00335b06f239bb149a5f0fbc277a1f4..a83f5b23fa6d0ce0d11b6d30c79a119c91fbaab1 100755 (executable)
@@ -2,38 +2,48 @@
 
 # zfec -- fast forward error correction library with Python interface
 # 
-# Copyright (C) 2007 Allmydata, Inc.
+# Copyright (C) 2007-2008 Allmydata, Inc.
 # Author: Zooko Wilcox-O'Hearn
 # 
 # This file is part of zfec.
-# 
-# This program is free software; you can redistribute it and/or modify it
-# under the terms of the GNU General Public License as published by the Free
-# Software Foundation; either version 2 of the License, or (at your option)
-# any later version, with the added permission that, if you become obligated
-# to release a derived work under this licence (as per section 2.b), you may
-# delay the fulfillment of this obligation for up to 12 months.  See the file
-# COPYING for details.
 #
-# If you would like to inquire about a commercial relationship with Allmydata,
-# Inc., please contact partnerships@allmydata.com and visit
-# http://allmydata.com/.
+# See README.txt for licensing information.
+
+import os, re, sys
+
+miscdeps=os.path.join(os.getcwd(), 'misc', 'dependencies')
 
-from ez_setup import use_setuptools
-use_setuptools(min_version='0.6a9')
+try:
+    from ez_setup import use_setuptools
+except ImportError:
+    pass
+else:
+    # On cygwin there was a permissions error that was fixed in 0.6c6.
+    use_setuptools(min_version='0.6c10', download_delay=0, to_dir=miscdeps)
 
 from setuptools import Extension, find_packages, setup
 
-DEBUGMODE=False
-# DEBUGMODE=True
+if "--debug" in sys.argv:
+    DEBUGMODE=True
+    sys.argv.remove("--debug")
+else:
+    DEBUGMODE=False
 
 extra_compile_args=[]
 extra_link_args=[]
 
 extra_compile_args.append("-std=c99")
 
+define_macros=[]
 undef_macros=[]
 
+for arg in sys.argv:
+    if arg.startswith("--stride="):
+        stride = int(arg[len("--stride="):])
+        define_macros.append(('STRIDE', stride))
+        sys.argv.remove(arg)
+        break
+
 if DEBUGMODE:
     extra_compile_args.append("-O0")
     extra_compile_args.append("-g")
@@ -46,6 +56,7 @@ trove_classifiers=[
     "Environment :: Console",
     "License :: OSI Approved :: GNU General Public License (GPL)", 
     "License :: DFSG approved",
+    "License :: Other/Proprietary License",
     "Intended Audience :: Developers", 
     "Intended Audience :: End Users/Desktop",
     "Intended Audience :: System Administrators",
@@ -60,6 +71,9 @@ trove_classifiers=[
     "Natural Language :: English", 
     "Programming Language :: C", 
     "Programming Language :: Python", 
+    "Programming Language :: Python :: 2",
+    "Programming Language :: Python :: 2.4",
+    "Programming Language :: Python :: 2.5",
     "Topic :: Utilities",
     "Topic :: System :: Systems Administration",
     "Topic :: System :: Filesystems",
@@ -71,34 +85,86 @@ trove_classifiers=[
     "Topic :: System :: Archiving", 
     ]
 
-import re
-VERSIONFILE = "zfec/_version.py"
+PKG = "zfec"
+VERSIONFILE = os.path.join(PKG, "_version.py")
 verstr = "unknown"
-VSRE = re.compile("^verstr = ['\"]([^'\"]*)['\"]", re.M)
 try:
     verstrline = open(VERSIONFILE, "rt").read()
 except EnvironmentError:
     pass # Okay, there is no version file.
 else:
-    mo = VSRE.search(verstrline)
+    VSRE = r"^verstr = ['\"]([^'\"]*)['\"]"
+    mo = re.search(VSRE, verstrline, re.M)
     if mo:
         verstr = mo.group(1)
     else:
         print "unable to find version in %s" % (VERSIONFILE,)
-        raise RuntimeError("if %s.py exists, it must be well-formed" % (VERSIONFILE,))
-
-setup(name='zfec',
-      install_requires=['pyutil>=1.0.0',],
-      version=verstr,
-      description='a fast erasure code with command-line, C, and Python interfaces',
-      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.',
-      author='Zooko O\'Whielacronx',
-      author_email='zooko@zooko.com',
-      url='http://allmydata.org/source/zfec',
-      license='GNU GPL',
-      packages=find_packages(),
-      classifiers=trove_classifiers,
-      entry_points = { 'console_scripts': [ 'zfec = zfec.cmdline_zfec:main', 'zunfec = zfec.cmdline_zunfec:main' ] },
-      ext_modules=[Extension('_fec', ['zfec/fec.c', 'zfec/_fecmodule.c',], extra_link_args=extra_link_args, extra_compile_args=extra_compile_args, undef_macros=undef_macros),],
-      test_suite="zfec.test",
-      )
+        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 = []
+
+# 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.
+# http://pypi.python.org/pypi/setuptools_darcs
+setup_requires.append('setuptools_darcs >= 1.1.0')
+
+data_fnames=[ 'COPYING.GPL', 'changelog', 'COPYING.TGPPL.html', 'TODO', 'README.txt' ]
+
+# In case we are building for a .deb with stdeb's sdist_dsc command, we put the
+# docs in "share/doc/python-$PKG".
+doc_loc = "share/doc/python-" + PKG
+data_files = [(doc_loc, data_fnames)]
+
+extras_require = {
+    'command_line_tools': ["argparse >= 0.8", "pyutil >= 1.3.19"]
+    }
+
+def _setup(test_suite):
+    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',
+          author='Zooko O\'Whielacronx',
+          author_email='zooko@zooko.com',
+          url='http://allmydata.org/trac/'+PKG,
+          license='GNU GPL',
+          dependency_links=dependency_links,
+          extras_require=extras_require,
+          tests_require=["pyutil >= 1.3.19"],
+          packages=find_packages(),
+          include_package_data=True,
+          data_files=data_files,
+          setup_requires=setup_requires,
+          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,
+          zip_safe=False, # I prefer unzipped for easier access.
+          )
+
+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