3 # Allmydata Tahoe -- secure, distributed storage grid
5 # Copyright (C) 2008 Allmydata, Inc.
7 # This file is part of tahoe.
9 # See the docs/about.html file for licensing information.
11 import os, re, shutil, stat, subprocess, sys, zipfile
13 ##### sys.path management
15 def pylibdir(prefixdir):
16 pyver = "python%d.%d" % (sys.version_info[:2])
17 if sys.platform == "win32":
18 return os.path.join(prefixdir, "Lib", "site-packages")
20 return os.path.join(prefixdir, "lib", pyver, "site-packages")
22 basedir = os.path.dirname(os.path.abspath(__file__))
23 supportlib = pylibdir(os.path.join(basedir, "support"))
26 for i in range(len(sys.argv)):
29 if arg.startswith("--prefix="):
30 prefixdir = arg[len("--prefix="):]
32 if len(sys.argv) > i+1:
33 prefixdir = sys.argv[i+1]
36 libdir = pylibdir(prefixdir)
39 except EnvironmentError, le:
40 # Okay, maybe the dir was already there.
42 sys.path.append(libdir)
43 pp = os.environ.get('PYTHONPATH','').split(os.pathsep)
45 os.environ['PYTHONPATH'] = os.pathsep.join(pp)
47 if arg.startswith("develop"):
48 if sys.platform == "linux2":
49 # workaround for tahoe #229 / setuptools #17, on debian
50 sys.argv.extend(["--site-dirs", "/var/lib/python-support/python%d.%d" % (sys.version_info[:2])])
51 elif sys.platform == "darwin":
52 # this probably only applies to leopard 10.5, possibly only 10.5.5
53 sd = "/System/Library/Frameworks/Python.framework/Versions/%d.%d/Extras/lib/python" % (sys.version_info[:2])
54 sys.argv.extend(["--site-dirs", sd])
57 from ez_setup import use_setuptools
61 # This invokes our own customized version of ez_setup.py to make sure that
62 # setuptools >= v0.6c8 (a.k.a. v0.6-final) is installed.
64 # setuptools < v0.6c8 doesn't handle eggs which get installed into the CWD
65 # as a result of being transitively depended on in a setup_requires, but
66 # then are needed for the installed code to run, i.e. in an
68 use_setuptools(download_delay=0, min_version="0.6c10dev")
70 from setuptools import find_packages, setup
71 from setuptools.command import sdist
72 from distutils.core import Command
73 from pkg_resources import require
75 # Make the dependency-version-requirement, which is used by the Makefile at
76 # build-time, also available to the app at runtime:
78 shutil.copyfile("_auto_deps.py", os.path.join("src", "allmydata", "_auto_deps.py"))
81 "Development Status :: 5 - Production/Stable",
82 "Environment :: Console",
83 "Environment :: Web Environment",
84 "License :: OSI Approved :: GNU General Public License (GPL)",
85 "License :: DFSG approved",
86 "License :: Other/Proprietary License",
87 "Intended Audience :: Developers",
88 "Intended Audience :: End Users/Desktop",
89 "Intended Audience :: System Administrators",
90 "Operating System :: Microsoft",
91 "Operating System :: Microsoft :: Windows",
92 "Operating System :: Microsoft :: Windows :: Windows NT/2000",
93 "Operating System :: Unix",
94 "Operating System :: POSIX :: Linux",
95 "Operating System :: POSIX",
96 "Operating System :: MacOS :: MacOS X",
97 "Operating System :: OS Independent",
98 "Natural Language :: English",
99 "Programming Language :: C",
100 "Programming Language :: Python",
101 "Programming Language :: Python :: 2",
102 "Programming Language :: Python :: 2.4",
103 "Programming Language :: Python :: 2.5",
104 "Topic :: Utilities",
105 "Topic :: System :: Systems Administration",
106 "Topic :: System :: Filesystems",
107 "Topic :: System :: Distributed Computing",
108 "Topic :: Software Development :: Libraries",
109 "Topic :: Communications :: Usenet News",
110 "Topic :: System :: Archiving :: Backup",
111 "Topic :: System :: Archiving :: Mirroring",
112 "Topic :: System :: Archiving",
116 VERSIONFILE = "src/allmydata/_version.py"
119 verstrline = open(VERSIONFILE, "rt").read()
120 except EnvironmentError:
121 pass # Okay, there is no version file.
123 VSRE = r"^verstr = ['\"]([^'\"]*)['\"]"
124 mo = re.search(VSRE, verstrline, re.M)
128 print "unable to find version in %s" % (VERSIONFILE,)
129 raise RuntimeError("if %s.py exists, it is required to be well-formed" % (VERSIONFILE,))
132 """Welcome to the Tahoe project, a secure, decentralized, fault-tolerant
133 filesystem. All of the source code is available under a Free Software, Open
136 This filesystem is encrypted and spread over multiple peers in such a way that
137 it remains available even when some of the peers are unavailable,
138 malfunctioning, or malicious."""
143 # Nevow requires Twisted to setup, but doesn't declare that requirement in a way that enables
144 # setuptools to satisfy that requirement before Nevow's setup.py tried to "import twisted".
145 setup_requires.extend(['Twisted >= 2.4.0', 'setuptools_trial'])
147 # darcsver is needed only if you want "./setup.py darcsver" to write a new
148 # version stamp in src/allmydata/_version.py, with a version number derived from
150 # http://pypi.python.org/pypi/darcsver
151 if 'darcsver' in sys.argv[1:]:
152 setup_requires.append('darcsver >= 1.1.5')
154 # setuptools_trial is needed only if you want "./setup.py trial" to execute the tests.
155 # http://pypi.python.org/pypi/setuptools_trial
156 if 'trial' in sys.argv[1:]:
157 # Cygwin requires the poll reactor to work at all. Linux requires the poll reactor to avoid
158 # bug #402 (twisted bug #3218). In general, the poll reactor is better than the select
159 # reactor, but it is not available on all platforms. According to exarkun on IRC, it is
160 # available but buggy on some versions of Mac OS X, so just because you can install it
161 # doesn't mean we want to use it on every platform.
162 if sys.platform in ("linux2", "cygwin"):
163 if not [a for a in sys.argv if a.startswith("--reactor")]:
164 sys.argv.append("--reactor=poll")
165 setup_requires.append('setuptools_trial >= 0.2')
167 # setuptools_darcs is required to produce complete distributions (such as with
168 # "sdist" or "bdist_egg"), unless there is a PKG-INFO file present which shows
169 # that this is itself a source distribution.
170 # http://pypi.python.org/pypi/setuptools_darcs
171 if not os.path.exists('PKG-INFO'):
172 setup_requires.append('setuptools_darcs >= 1.1.0')
174 class ShowSupportLib(Command):
176 def initialize_options(self):
178 def finalize_options(self):
181 # TODO: --quiet suppresses the 'running show_supportlib' message.
182 # Find a way to do this all the time.
183 print supportlib # TODO windowsy
185 class ShowPythonPath(Command):
187 def initialize_options(self):
189 def finalize_options(self):
192 # TODO: --quiet suppresses the 'running show_supportlib' message.
193 # Find a way to do this all the time.
194 print "PYTHONPATH=%s" % os.environ.get("PYTHONPATH", '')
196 class RunWithPythonPath(Command):
197 description = "Run a subcommand with PYTHONPATH set appropriately"
199 user_options = [ ("python", "p",
200 "Treat command string as arguments to a python executable"),
201 ("command=", "c", "Command to be run"),
202 ("directory=", "d", "Directory to run the command in"),
204 boolean_options = ["python"]
206 def initialize_options(self):
209 self.directory = None
210 def finalize_options(self):
213 oldpp = os.environ.get("PYTHONPATH", "").split(os.pathsep)
215 # grr silly split() behavior
217 os.environ['PYTHONPATH'] = os.pathsep.join(oldpp + [supportlib,])
219 # We must require the command to be safe to split on
220 # whitespace, and have --python and --directory to make it
221 # easier to achieve this.
225 command.append(sys.executable)
227 command.extend(self.command.split())
229 raise RuntimeError("The --command argument is mandatory")
231 os.chdir(self.directory)
233 print "command =", " ".join(command)
234 rc = subprocess.call(command)
237 class CheckAutoDeps(Command):
239 def initialize_options(self):
241 def finalize_options(self):
245 _auto_deps.require_auto_deps()
248 class BuildTahoe(Command):
250 def initialize_options(self):
252 def finalize_options(self):
256 bin_tahoe = os.path.join("bin", "tahoe")
257 old_mode = stat.S_IMODE(os.stat(bin_tahoe)[stat.ST_MODE])
258 new_mode = old_mode | (stat.S_IXUSR | stat.S_IRUSR |
259 stat.S_IXGRP | stat.S_IRGRP |
260 stat.S_IXOTH | stat.S_IROTH )
261 os.chmod(bin_tahoe, new_mode)
263 # On Windows, create the 'tahoe-script.py' file based on the 'tahoe'
264 # executable script under the 'bin' directory so that the tahoe.exe
265 # will work correctly. The 'tahoe-script.py' file is exactly the same
266 # as the 'tahoe' script except that we need to update the she-bang
267 # line. The tahoe.exe will be copied from the setuptools egg's cli.exe
268 # and this will work from a zip-safe and non-zip-safe setuptools egg.
269 if sys.platform == "win32":
270 setuptools_egg = require("setuptools")[0].location
271 if os.path.isfile(setuptools_egg):
272 z = zipfile.ZipFile(setuptools_egg, 'r')
273 for filename in z.namelist():
274 if 'cli.exe' in filename:
275 cli_exe = z.read(filename)
277 cli_exe = os.path.join(setuptools_egg, 'setuptools', 'cli.exe')
278 tahoe_exe = os.path.join("bin", "tahoe.exe")
279 if os.path.isfile(setuptools_egg):
280 f = open(tahoe_exe, 'wb')
284 shutil.copy(cli_exe, tahoe_exe)
285 f = open(bin_tahoe, "r")
286 script_lines = f.readlines()
288 script_lines[0] = "#!%s\n" % sys.executable
289 tahoe_script = os.path.join("bin", "tahoe-script.py")
290 f = open(tahoe_script, "w")
291 for line in script_lines:
295 command = [sys.executable, "setup.py", "develop", "--multi-version",
297 print "Command:", " ".join(command)
298 rc = subprocess.call(command)
300 print >>sys.stderr, "'setup.py develop' terminated by signal", -rc
303 print >>sys.stderr, "'setup.py develop' exited with rc", rc
306 class MySdist(sdist.sdist):
307 """ A hook in the sdist command so that we can determine whether this the
308 tarball should be 'SUMO' or not, i.e. whether or not to include the
309 external dependency tarballs. Note that we always include
310 misc/dependencies/* in the tarball; --sumo controls whether tahoe-deps/*
314 user_options = sdist.sdist.user_options + \
316 "create a 'sumo' sdist which includes the contents of tahoe-deps/*"),
318 boolean_options = ['sumo']
320 def initialize_options(self):
321 sdist.sdist.initialize_options(self)
324 def make_distribution(self):
325 # add our extra files to the list just before building the
326 # tarball/zipfile. We override make_distribution() instead of run()
327 # because setuptools.command.sdist.run() does not lend itself to
328 # easy/robust subclassing (the code we need to add goes right smack
329 # in the middle of a 12-line method). If this were the distutils
330 # version, we'd override get_file_list().
333 # If '--sumo' was specified, include tahoe-deps/* in the sdist.
334 # We assume that the user has fetched the tahoe-deps.tar.gz
335 # tarball and unpacked it already.
336 self.filelist.extend([os.path.join("tahoe-deps", fn)
337 for fn in os.listdir("tahoe-deps")])
338 # In addition, we want the tarball/zipfile to have -SUMO in the
339 # name, and the unpacked directory to have -SUMO too. The easiest
340 # way to do this is to patch self.distribution and override the
341 # get_fullname() method. (an alternative is to modify
342 # self.distribution.metadata.version, but that also affects the
343 # contents of PKG-INFO).
344 fullname = self.distribution.get_fullname()
346 return fullname + "-SUMO"
347 self.distribution.get_fullname = get_fullname
349 return sdist.sdist.make_distribution(self)
351 # Tahoe's dependencies are managed by the find_links= entry in setup.cfg and
352 # the _auto_deps.install_requires list, which is used in the call to setup()
353 # at the end of this file
354 from _auto_deps import install_requires
356 setup(name='allmydata-tahoe',
358 description='secure, decentralized, fault-tolerant filesystem',
359 long_description=LONG_DESCRIPTION,
360 author='the allmydata.org Tahoe project',
361 author_email='tahoe-dev@allmydata.org',
362 url='http://allmydata.org/',
364 cmdclass={"show_supportlib": ShowSupportLib,
365 "show_pythonpath": ShowPythonPath,
366 "run_with_pythonpath": RunWithPythonPath,
367 "check_auto_deps": CheckAutoDeps,
368 "build_tahoe": BuildTahoe,
371 package_dir = {'':'src'},
372 packages=find_packages("src"),
373 classifiers=trove_classifiers,
374 test_suite="allmydata.test",
375 install_requires=install_requires,
376 include_package_data=True,
377 setup_requires=setup_requires,
378 entry_points = { 'console_scripts': [ 'tahoe = allmydata.scripts.runner:run' ] },
379 zip_safe=False, # We prefer unzipped for easier access.