2 # -*- coding: utf-8 -*-
4 # Tahoe-LAFS -- secure, distributed storage grid
6 # Copyright © 2008-2010 Allmydata, Inc.
8 # This file is part of Tahoe-LAFS.
10 # See the docs/about.html file for licensing information.
12 import glob, os, stat, subprocess, sys, re
14 ##### sys.path management
16 def pylibdir(prefixdir):
17 pyver = "python%d.%d" % (sys.version_info[:2])
18 if sys.platform == "win32":
19 return os.path.join(prefixdir, "Lib", "site-packages")
21 return os.path.join(prefixdir, "lib", pyver, "site-packages")
23 basedir = os.path.dirname(os.path.abspath(__file__))
24 supportlib = pylibdir(os.path.join(basedir, "support"))
26 # locate our version number
28 def read_version_py(infname):
30 verstrline = open(infname, "rt").read()
31 except EnvironmentError:
34 VSRE = r"^verstr = ['\"]([^'\"]*)['\"]"
35 mo = re.search(VSRE, verstrline, re.M)
39 version = read_version_py("src/allmydata/_version.py")
41 APPNAME='allmydata-tahoe'
42 APPNAMEFILE = os.path.join('src', 'allmydata', '_appname.py')
43 APPNAMEFILESTR = "__appname__ = '%s'" % (APPNAME,)
45 curappnamefilestr = open(APPNAMEFILE, 'rU').read()
46 except EnvironmentError:
47 # No file, or unreadable or something, okay then let's try to write one.
48 open(APPNAMEFILE, "w").write(APPNAMEFILESTR)
50 if curappnamefilestr.strip() != APPNAMEFILESTR:
51 print "Error -- this setup.py file is configured with the 'application name' to be '%s', but there is already a file in place in '%s' which contains the contents '%s'. If the file is wrong, please remove it and setup.py will regenerate it and write '%s' into it." % (APPNAME, APPNAMEFILE, curappnamefilestr, APPNAMEFILESTR)
54 # setuptools/zetuptoolz looks in __main__.__requires__ for a list of
55 # requirements. When running "python setup.py test", __main__ is
56 # setup.py, so we put the list here so that the requirements will be
57 # available for tests:
59 # Tahoe's dependencies are managed by the find_links= entry in setup.cfg and
60 # the _auto_deps.install_requires list, which is used in the call to setup()
63 execfile('src/allmydata/_auto_deps.py', adglobals)
64 install_requires = adglobals['install_requires']
66 if len(sys.argv) > 1 and sys.argv[1] == '--fakedependency':
68 install_requires += ["fakedependency >= 1.0.0"]
70 __requires__ = install_requires[:]
72 egg = os.path.realpath(glob.glob('setuptools-*.egg')[0])
73 sys.path.insert(0, egg)
74 egg = os.path.realpath(glob.glob('darcsver-*.egg')[0])
75 sys.path.insert(0, egg)
76 egg = os.path.realpath(glob.glob('setuptools_darcs-*.egg')[0])
77 sys.path.insert(0, egg)
78 import setuptools; setuptools.bootstrap_install_from = egg
80 from setuptools import find_packages, setup
81 from setuptools.command import sdist
82 from setuptools import Command
85 "Development Status :: 5 - Production/Stable",
86 "Environment :: Console",
87 "Environment :: Web Environment",
88 "License :: OSI Approved :: GNU General Public License (GPL)",
89 "License :: DFSG approved",
90 "License :: Other/Proprietary License",
91 "Intended Audience :: Developers",
92 "Intended Audience :: End Users/Desktop",
93 "Intended Audience :: System Administrators",
94 "Operating System :: Microsoft",
95 "Operating System :: Microsoft :: Windows",
96 "Operating System :: Microsoft :: Windows :: Windows NT/2000",
97 "Operating System :: Unix",
98 "Operating System :: POSIX :: Linux",
99 "Operating System :: POSIX",
100 "Operating System :: MacOS :: MacOS X",
101 "Operating System :: OS Independent",
102 "Natural Language :: English",
103 "Programming Language :: C",
104 "Programming Language :: Python",
105 "Programming Language :: Python :: 2",
106 "Programming Language :: Python :: 2.4",
107 "Programming Language :: Python :: 2.5",
108 "Programming Language :: Python :: 2.6",
109 "Programming Language :: Python :: 2.7",
110 "Topic :: Utilities",
111 "Topic :: System :: Systems Administration",
112 "Topic :: System :: Filesystems",
113 "Topic :: System :: Distributed Computing",
114 "Topic :: Software Development :: Libraries",
115 "Topic :: Communications :: Usenet News",
116 "Topic :: System :: Archiving :: Backup",
117 "Topic :: System :: Archiving :: Mirroring",
118 "Topic :: System :: Archiving",
124 # The darcsver command from the darcsver plugin is needed to initialize the
125 # distribution's .version attribute correctly. (It does this either by
126 # examining darcs history, or if that fails by reading the
127 # src/allmydata/_version.py file). darcsver will also write a new version
128 # stamp in src/allmydata/_version.py, with a version number derived from
129 # darcs history. Note that the setup.cfg file has an "[aliases]" section
130 # which enumerates commands that you might run and specifies that it will run
131 # darcsver before each one. If you add different commands (or if I forgot
132 # some that are already in use), you may need to add it to setup.cfg and
133 # configure it to run darcsver before your command, if you want the version
134 # number to be correct when that command runs.
135 # http://pypi.python.org/pypi/darcsver
136 setup_requires.append('darcsver >= 1.7.2')
138 # Nevow requires Twisted to setup, but prior to Nevow v0.9.33, didn't
139 # declare that requirement in a way that enables setuptools to satisfy
140 # the requirement before Nevow's setup.py tries to "import twisted".
141 # This only matters when Twisted is not already installed.
142 # See http://divmod.org/trac/ticket/2629
143 # Retire this hack if/when we require Nevow >= 0.9.33.
144 setup_requires.append('Twisted >= 2.4.0')
146 # setuptools_darcs is required to produce complete distributions (such
147 # as with "sdist" or "bdist_egg"), unless there is a
148 # src/allmydata_tahoe.egg-info/SOURCE.txt file, which if present
149 # contains a complete list of files that should be included.
150 # http://pypi.python.org/pypi/setuptools_darcs
151 setup_requires.append('setuptools_darcs >= 1.1.0')
153 # trialcoverage is required if you want the "trial" unit test runner to have a
154 # "--reporter=bwverbose-coverage" option which produces code-coverage results.
155 # The required version is 0.3.3, because that is the latest version that only
156 # depends on a version of pycoverage for which binary packages are available.
157 if "--reporter=bwverbose-coverage" in sys.argv:
158 setup_requires.append('trialcoverage >= 0.3.3')
160 # stdeb is required to produce Debian files with the "sdist_dsc" command.
161 if "sdist_dsc" in sys.argv:
162 setup_requires.append('stdeb >= 0.3')
164 # We no longer have any requirements specific to tests.
168 class ShowSupportLib(Command):
170 def initialize_options(self):
172 def finalize_options(self):
175 # TODO: --quiet suppresses the 'running show_supportlib' message.
176 # Find a way to do this all the time.
177 print supportlib # TODO windowsy
179 class ShowPythonPath(Command):
181 def initialize_options(self):
183 def finalize_options(self):
186 # TODO: --quiet suppresses the 'running show_supportlib' message.
187 # Find a way to do this all the time.
188 print "PYTHONPATH=%s" % os.environ.get("PYTHONPATH", '')
190 class RunWithPythonPath(Command):
191 description = "Run a subcommand with PYTHONPATH set appropriately"
193 user_options = [ ("python", "p",
194 "Treat command string as arguments to a python executable"),
195 ("command=", "c", "Command to be run"),
196 ("directory=", "d", "Directory to run the command in"),
198 boolean_options = ["python"]
200 def initialize_options(self):
203 self.directory = None
204 def finalize_options(self):
207 oldpp = os.environ.get("PYTHONPATH", "").split(os.pathsep)
209 # grr silly split() behavior
211 os.environ['PYTHONPATH'] = os.pathsep.join(oldpp + [supportlib,])
213 # We must require the command to be safe to split on
214 # whitespace, and have --python and --directory to make it
215 # easier to achieve this.
219 command.append(sys.executable)
221 command.extend(self.command.split())
223 raise RuntimeError("The --command argument is mandatory")
225 os.chdir(self.directory)
227 print "command =", " ".join(command)
228 rc = subprocess.call(command)
231 class TestMacDiskImage(Command):
232 description = "test the Mac disk image in dmg format (unmaintained)"
235 def initialize_options(self):
237 def finalize_options(self):
241 sys.path.append(os.path.join('misc', 'build_helpers'))
242 import test_mac_diskimage
243 return test_mac_diskimage.test_mac_diskimage('Allmydata', version=self.distribution.metadata.version)
246 class Trial(Command):
247 description = "run trial (use 'bin%stahoe debug trial' for the full set of trial options)" % (os.sep,)
248 # This is just a subset of the most useful options, for compatibility.
249 user_options = [ ("rterrors", "e", "Print out tracebacks as soon as they occur."),
250 ("reporter=", None, "The reporter to use for this test run."),
251 ("suite=", "s", "Specify the test suite."),
252 ("quiet", None, "Don't display version numbers and paths of Tahoe dependencies."),
255 def initialize_options(self):
256 self.rterrors = False
258 self.suite = "allmydata"
261 def finalize_options(self):
265 args = [sys.executable, os.path.join('bin', 'tahoe')]
267 args.append('--version-and-path')
268 args += ['debug', 'trial']
270 args.append('--rterrors')
272 args.append('--reporter=' + self.reporter)
274 args.append(self.suite)
275 rc = subprocess.call(args)
279 class MakeExecutable(Command):
280 description = "make the 'bin%stahoe' scripts" % (os.sep,)
283 def initialize_options(self):
285 def finalize_options(self):
288 bin_tahoe_template = os.path.join("bin", "tahoe-script.template")
290 # tahoe.pyscript is really only necessary for Windows, but we also
291 # create it on Unix for consistency.
292 script_names = ["tahoe.pyscript", "tahoe"]
294 # Create the tahoe script file under the 'bin' directory. This
295 # file is exactly the same as the 'tahoe-script.template' script
296 # except that the shebang line is rewritten to use our sys.executable
297 # for the interpreter.
298 f = open(bin_tahoe_template, "rU")
299 script_lines = f.readlines()
301 script_lines[0] = '#!%s\n' % (sys.executable,)
302 for script_name in script_names:
303 tahoe_script = os.path.join("bin", script_name)
305 os.remove(tahoe_script)
307 if os.path.exists(tahoe_script):
309 f = open(tahoe_script, "wb")
310 for line in script_lines:
315 old_mode = stat.S_IMODE(os.stat(tahoe_script)[stat.ST_MODE])
316 new_mode = old_mode | (stat.S_IXUSR | stat.S_IRUSR |
317 stat.S_IXGRP | stat.S_IRGRP |
318 stat.S_IXOTH | stat.S_IROTH )
319 os.chmod(tahoe_script, new_mode)
321 old_tahoe_exe = os.path.join("bin", "tahoe.exe")
323 os.remove(old_tahoe_exe)
325 if os.path.exists(old_tahoe_exe):
329 class MySdist(sdist.sdist):
330 """ A hook in the sdist command so that we can determine whether this the
331 tarball should be 'SUMO' or not, i.e. whether or not to include the
332 external dependency tarballs. Note that we always include
333 misc/dependencies/* in the tarball; --sumo controls whether tahoe-deps/*
337 user_options = sdist.sdist.user_options + \
339 "create a 'sumo' sdist which includes the contents of tahoe-deps/*"),
341 boolean_options = ['sumo']
343 def initialize_options(self):
344 sdist.sdist.initialize_options(self)
347 def make_distribution(self):
348 # add our extra files to the list just before building the
349 # tarball/zipfile. We override make_distribution() instead of run()
350 # because setuptools.command.sdist.run() does not lend itself to
351 # easy/robust subclassing (the code we need to add goes right smack
352 # in the middle of a 12-line method). If this were the distutils
353 # version, we'd override get_file_list().
356 # If '--sumo' was specified, include tahoe-deps/* in the sdist.
357 # We assume that the user has fetched the tahoe-deps.tar.gz
358 # tarball and unpacked it already.
359 self.filelist.extend([os.path.join("tahoe-deps", fn)
360 for fn in os.listdir("tahoe-deps")])
361 # In addition, we want the tarball/zipfile to have -SUMO in the
362 # name, and the unpacked directory to have -SUMO too. The easiest
363 # way to do this is to patch self.distribution and override the
364 # get_fullname() method. (an alternative is to modify
365 # self.distribution.metadata.version, but that also affects the
366 # contents of PKG-INFO).
367 fullname = self.distribution.get_fullname()
369 return fullname + "-SUMO"
370 self.distribution.get_fullname = get_fullname
372 return sdist.sdist.make_distribution(self)
377 setup_args["version"] = version
380 description='secure, decentralized, fault-tolerant filesystem',
381 long_description=open('README.txt', 'rU').read(),
382 author='the Tahoe-LAFS project',
383 author_email='tahoe-dev@tahoe-lafs.org',
384 url='http://tahoe-lafs.org/',
385 license='GNU GPL', # see README.txt -- there is an alternative licence
386 cmdclass={"show_supportlib": ShowSupportLib,
387 "show_pythonpath": ShowPythonPath,
388 "run_with_pythonpath": RunWithPythonPath,
389 "test_mac_diskimage": TestMacDiskImage,
391 "make_executable": MakeExecutable,
394 package_dir = {'':'src'},
395 packages=find_packages("src"),
396 classifiers=trove_classifiers,
397 test_suite="allmydata.test",
398 install_requires=install_requires,
399 tests_require=tests_require,
400 include_package_data=True,
401 setup_requires=setup_requires,
402 entry_points = { 'console_scripts': [ 'tahoe = allmydata.scripts.runner:run' ] },
403 zip_safe=False, # We prefer unzipped for easier access.
404 versionfiles=['src/allmydata/_version.py',],