zfec/setup.py

   1 #!/usr/bin/env python
   2
   3 # zfec -- fast forward error correction library with Python interface
   4 #
   5 # Copyright (C) 2007-2010 Allmydata, Inc.
   6 # Author: Zooko Wilcox-O'Hearn
   7 #
   8 # This file is part of zfec.
   9 #
  10 # See README.rst for licensing information.
  11
  12 import glob, os, re, sys
  13
  14 egg = os.path.realpath(glob.glob('setuptools-*.egg')[0])
  15 sys.path.insert(0, egg)
  16 import setuptools; setuptools.bootstrap_install_from = egg
  17
  18 from setuptools import Extension, find_packages, setup
  19
  20 if "--debug" in sys.argv:
  21     DEBUGMODE=True
  22     sys.argv.remove("--debug")
  23 else:
  24     DEBUGMODE=False
  25
  26 extra_compile_args=[]
  27 extra_link_args=[]
  28
  29 extra_compile_args.append("-std=c99")
  30
  31 define_macros=[]
  32 undef_macros=[]
  33
  34 for arg in sys.argv:
  35     if arg.startswith("--stride="):
  36         stride = int(arg[len("--stride="):])
  37         define_macros.append(('STRIDE', stride))
  38         sys.argv.remove(arg)
  39         break
  40
  41 if DEBUGMODE:
  42     extra_compile_args.append("-O0")
  43     extra_compile_args.append("-g")
  44     extra_compile_args.append("-Wall")
  45     extra_link_args.append("-g")
  46     undef_macros.append('NDEBUG')
  47
  48 trove_classifiers=[
  49     "Development Status :: 5 - Production/Stable",
  50     "Environment :: Console",
  51     "License :: OSI Approved :: GNU General Public License (GPL)",
  52     "License :: DFSG approved",
  53     "License :: Other/Proprietary License",
  54     "Intended Audience :: Developers",
  55     "Intended Audience :: End Users/Desktop",
  56     "Intended Audience :: System Administrators",
  57     "Operating System :: Microsoft",
  58     "Operating System :: Microsoft :: Windows",
  59     "Operating System :: Unix",
  60     "Operating System :: POSIX :: Linux",
  61     "Operating System :: POSIX",
  62     "Operating System :: MacOS :: MacOS X",
  63     "Operating System :: Microsoft :: Windows :: Windows NT/2000",
  64     "Operating System :: OS Independent",
  65     "Natural Language :: English",
  66     "Programming Language :: C",
  67     "Programming Language :: Python",
  68     "Programming Language :: Python :: 2",
  69     "Programming Language :: Python :: 2.4",
  70     "Programming Language :: Python :: 2.5",
  71     "Topic :: Utilities",
  72     "Topic :: System :: Systems Administration",
  73     "Topic :: System :: Filesystems",
  74     "Topic :: System :: Distributed Computing",
  75     "Topic :: Software Development :: Libraries",
  76     "Topic :: Communications :: Usenet News",
  77     "Topic :: System :: Archiving :: Backup",
  78     "Topic :: System :: Archiving :: Mirroring",
  79     "Topic :: System :: Archiving",
  80     ]
  81
  82 PKG = "zfec"
  83 VERSIONFILE = os.path.join(PKG, "_version.py")
  84 verstr = "unknown"
  85 try:
  86     verstrline = open(VERSIONFILE, "rt").read()
  87 except EnvironmentError:
  88     pass # Okay, there is no version file.
  89 else:
  90     VSRE = r"^verstr = ['\"]([^'\"]*)['\"]"
  91     mo = re.search(VSRE, verstrline, re.M)
  92     if mo:
  93         verstr = mo.group(1)
  94     else:
  95         print "unable to find version in %s" % (VERSIONFILE,)
  96         raise RuntimeError("if %s.py exists, it is required to be well-formed" % (VERSIONFILE,))
  97
  98 setup_requires = []
  99 tests_require = []
 100
 101 tests_require.append("pyutil >= 1.3.19")
 102
 103 # The darcsver command from the darcsver plugin is needed to initialize the
 104 # distribution's .version attribute correctly. (It does this either by
 105 # examining darcs history, or if that fails by reading the
 106 # zfec/_version.py file). darcsver will also write a new version
 107 # stamp in zfec/_version.py, with a version number derived from
 108 # darcs history. Note that the setup.cfg file has an "[aliases]" section
 109 # which enumerates commands that you might run and specifies that it will run
 110 # darcsver before each one. If you add different commands (or if I forgot
 111 # some that are already in use), you may need to add it to setup.cfg and
 112 # configure it to run darcsver before your command, if you want the version
 113 # number to be correct when that command runs.
 114 # http://pypi.python.org/pypi/darcsver
 115 setup_requires.append('darcsver >= 1.2.0')
 116
 117 # setuptools_darcs is required to produce complete distributions (such
 118 # as with "sdist" or "bdist_egg"), unless there is a
 119 # zfec.egg-info/SOURCE.txt file present which contains a complete
 120 # list of files that should be included.
 121 # http://pypi.python.org/pypi/setuptools_darcs However, requiring it
 122 # runs afoul of a bug in Distribute, which was shipped in Ubuntu
 123 # Lucid, so for now you have to manually install it before building
 124 # sdists or eggs:
 125 # 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
 126 if False:
 127     setup_requires.append('setuptools_darcs >= 1.1.0')
 128
 129
 130 setup_requires.append('setuptools_trial >= 0.5')
 131
 132 # trialcoverage is required if you want the "trial" unit test runner to have a
 133 # "--reporter=bwverbose-coverage" option which produces code-coverage results.
 134 if "--reporter=bwverbose-coverage" in sys.argv:
 135     tests_require.append('trialcoverage >= 0.3.3')
 136     tests_require.append('twisted >= 2.4.0')
 137     tests_require.append('setuptools_trial >= 0.5')
 138
 139 # stdeb is required to build Debian dsc files.
 140 if "sdist_dsc" in sys.argv:
 141     setup_requires.append('stdeb')
 142
 143 data_fnames=[ 'COPYING.GPL', 'changelog', 'COPYING.TGPPL.html', 'TODO', 'README.rst' ]
 144
 145 # In case we are building for a .deb with stdeb's sdist_dsc command, we put the
 146 # docs in "share/doc/$PKG".
 147 doc_loc = "share/doc/" + PKG
 148 data_files = [(doc_loc, data_fnames)]
 149
 150 setup(name=PKG,
 151       version=verstr,
 152       description='a fast erasure codec which can be used with the command-line, C, Python, or Haskell',
 153       long_description = open('README.rst').read(),
 154       author='Zooko O\'Whielacronx',
 155       author_email='zooko@zooko.com',
 156       url='http://tahoe-lafs.org/trac/'+PKG,
 157       license='GNU GPL',
 158       install_requires=["argparse >= 0.8", "pyutil >= 1.3.19"],
 159       tests_require=tests_require,
 160       packages=find_packages(),
 161       include_package_data=True,
 162       data_files=data_files,
 163       setup_requires=setup_requires,
 164       classifiers=trove_classifiers,
 165       entry_points = { 'console_scripts': [ 'zfec = %s.cmdline_zfec:main' % PKG, 'zunfec = %s.cmdline_zunfec:main' % PKG ] },
 166       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),],
 167       test_suite=PKG+".test",
 168       zip_safe=False, # I prefer unzipped for easier access.
 169       )