1
1
#! /usr/bin/env python
3
# This is an installation script for bzr. Run it with
4
# './setup.py install', or
5
# './setup.py --help' for more options
3
"""Installation script for bzr.
5
'./setup.py install', or
6
'./setup.py --help' for more options
13
if sys.version_info < (2, 4):
14
sys.stderr.write("[ERROR] Not a supported Python version. Need 2.4+\n")
17
# NOTE: The directory containing setup.py, whether run by 'python setup.py' or
18
# './setup.py' or the equivalent with another path, should always be at the
19
# start of the path, so this should find the right one...
22
def get_long_description():
23
dirname = os.path.dirname(__file__)
24
readme = os.path.join(dirname, 'README')
25
f = open(readme, 'rb')
33
# META INFORMATION FOR SETUP
34
# see http://docs.python.org/dist/meta-data.html
37
'version': bzrlib.__version__,
38
'author': 'Canonical Ltd',
39
'author_email': 'bazaar@lists.canonical.com',
40
'url': 'http://www.bazaar-vcs.org/',
41
'description': 'Friendly distributed version control system',
42
'license': 'GNU GPL v2',
43
'download_url': 'http://bazaar-vcs.org/Download',
44
'long_description': get_long_description(),
46
'Development Status :: 6 - Mature',
47
'Environment :: Console',
48
'Intended Audience :: Developers',
49
'Intended Audience :: System Administrators',
50
'License :: OSI Approved :: GNU General Public License (GPL)',
51
'Operating System :: Microsoft :: Windows',
52
'Operating System :: OS Independent',
53
'Operating System :: POSIX',
54
'Programming Language :: Python',
55
'Programming Language :: C',
56
'Topic :: Software Development :: Version Control',
60
# The list of packages is automatically generated later. Add other things
61
# that are part of BZRLIB here.
64
PKG_DATA = {# install files from selftest suite
65
'package_data': {'bzrlib': ['doc/api/*.txt',
66
'tests/test_patches_data/*',
67
'help_topics/en/*.txt',
72
def get_bzrlib_packages():
73
"""Recurse through the bzrlib directory, and extract the package names"""
76
base_path = os.path.dirname(os.path.abspath(bzrlib.__file__))
77
for root, dirs, files in os.walk(base_path):
78
if '__init__.py' in files:
79
assert root.startswith(base_path)
80
# Get just the path below bzrlib
81
package_path = root[len(base_path):]
82
# Remove leading and trailing slashes
83
package_path = package_path.strip('\\/')
85
package_name = 'bzrlib'
87
package_name = ('bzrlib.' +
88
package_path.replace('/', '.').replace('\\', '.'))
89
packages.append(package_name)
90
return sorted(packages)
93
BZRLIB['packages'] = get_bzrlib_packages()
7
96
from distutils.core import setup
12
author_email='mbp@sourcefrog.net',
13
url='http://www.bazaar-ng.org/',
14
description='Friendly distributed version control system',
20
'bzrlib.util.elementtree',
21
'bzrlib.util.effbot.org',
97
from distutils.command.install_scripts import install_scripts
98
from distutils.command.install_data import install_data
99
from distutils.command.build import build
101
###############################
102
# Overridden distutils actions
103
###############################
105
class my_install_scripts(install_scripts):
106
""" Customized install_scripts distutils action.
107
Create bzr.bat for win32.
110
install_scripts.run(self) # standard action
112
if sys.platform == "win32":
114
scripts_dir = os.path.join(sys.prefix, 'Scripts')
115
script_path = self._quoted_path(os.path.join(scripts_dir,
117
python_exe = self._quoted_path(sys.executable)
118
args = self._win_batch_args()
119
batch_str = "@%s %s %s" % (python_exe, script_path, args)
120
batch_path = os.path.join(self.install_dir, "bzr.bat")
121
f = file(batch_path, "w")
124
print "Created:", batch_path
126
print "ERROR: Unable to create %s: %s" % (batch_path, e)
128
def _quoted_path(self, path):
130
return '"' + path + '"'
134
def _win_batch_args(self):
135
from bzrlib.win32utils import winver
136
if winver == 'Windows NT':
139
return '%1 %2 %3 %4 %5 %6 %7 %8 %9'
140
#/class my_install_scripts
143
class bzr_build(build):
144
"""Customized build distutils action.
151
generate_docs.main(argv=["bzr", "man"])
154
########################
156
########################
158
command_classes = {'install_scripts': my_install_scripts,
160
from distutils import log
161
from distutils.errors import CCompilerError, DistutilsPlatformError
162
from distutils.extension import Extension
165
from Pyrex.Distutils import build_ext
168
# try to build the extension from the prior generated source.
170
print ("The python package 'Pyrex' is not available."
171
" If the .c files are available,")
172
print ("they will be built,"
173
" but modifying the .pyx files will not rebuild them.")
175
from distutils.command.build_ext import build_ext
180
class build_ext_if_possible(build_ext):
185
except DistutilsPlatformError, e:
187
log.warn('Extensions cannot be built, '
188
'will use the Python versions instead')
190
def build_extension(self, ext):
192
build_ext.build_extension(self, ext)
193
except CCompilerError:
194
log.warn('Building of "%s" extension failed, '
195
'will use the Python version instead' % (ext.name,))
198
# Override the build_ext if we have Pyrex available
199
command_classes['build_ext'] = build_ext_if_possible
200
unavailable_files = []
203
def add_pyrex_extension(module_name, **kwargs):
204
"""Add a pyrex module to build.
206
This will use Pyrex to auto-generate the .c file if it is available.
207
Otherwise it will fall back on the .c file. If the .c file is not
208
available, it will warn, and not add anything.
210
You can pass any extra options to Extension through kwargs. One example is
213
:param module_name: The python path to the module. This will be used to
214
determine the .pyx and .c files to use.
216
path = module_name.replace('.', '/')
217
pyrex_name = path + '.pyx'
220
ext_modules.append(Extension(module_name, [pyrex_name], **kwargs))
222
if not os.path.isfile(c_name):
223
unavailable_files.append(c_name)
225
ext_modules.append(Extension(module_name, [c_name], **kwargs))
228
add_pyrex_extension('bzrlib._btree_serializer_c')
229
add_pyrex_extension('bzrlib._dirstate_helpers_c')
230
add_pyrex_extension('bzrlib._knit_load_data_c')
231
if sys.platform == 'win32':
232
# pyrex uses the macro WIN32 to detect the platform, even though it should
233
# be using something like _WIN32 or MS_WINDOWS, oh well, we can give it the
235
add_pyrex_extension('bzrlib._walkdirs_win32',
236
define_macros=[('WIN32', None)])
237
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
240
if unavailable_files:
241
print 'C extension(s) not found:'
242
print ' %s' % ('\n '.join(unavailable_files),)
243
print 'The python versions will be used instead.'
247
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
249
packages.append('tbzrcommands')
251
# ModuleFinder can't handle runtime changes to __path__, but
252
# win32com uses them. Hook this in so win32com.shell is found.
255
for p in win32com.__path__[1:]:
256
modulefinder.AddPackagePath("win32com", p)
257
for extra in ["win32com.shell"]:
259
m = sys.modules[extra]
260
for p in m.__path__[1:]:
261
modulefinder.AddPackagePath(extra, p)
263
# TBZR points to the TBZR directory
264
tbzr_root = os.environ["TBZR"]
266
# Ensure tbzrlib itself is on sys.path
267
sys.path.append(tbzr_root)
269
# Ensure our COM "entry-point" is on sys.path
270
sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
272
packages.append("tbzrlib")
273
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
274
win32ui crawler.Crawler""".split())
278
create_exe = False, # we only want a .dll
280
com_targets.append(tbzr)
282
# tbzrcache executables - a "console" version for debugging and a
283
# GUI version that is generally used.
285
script = os.path.join(tbzr_root, "Scripts", "tbzrcache.py"),
286
icon_resources = [(0,'bzr.ico')],
288
console_targets.append(tbzrcache)
290
# Make a windows version which is the same except for the base name.
291
tbzrcachew = tbzrcache.copy()
292
tbzrcachew["dest_base"]="tbzrcachew"
293
gui_targets.append(tbzrcachew)
295
# ditto for the tbzrcommand tool
297
script = os.path.join(tbzr_root, "Scripts", "tbzrcommand.py"),
298
icon_resources = [(0,'bzr.ico')],
300
console_targets.append(tbzrcommand)
301
tbzrcommandw = tbzrcommand.copy()
302
tbzrcommandw["dest_base"]="tbzrcommandw"
303
gui_targets.append(tbzrcommandw)
307
script = os.path.join(tbzr_root, "Scripts", "tbzrtest.py"),
309
console_targets.append(tbzrtest)
311
# A utility to see python output from the shell extension - this will
312
# die when we get a c++ extension
313
# any .py file from pywin32's win32 lib will do (other than
314
# win32traceutil itself that is)
316
win32_lib_dir = os.path.dirname(winerror.__file__)
317
tracer = dict(script = os.path.join(win32_lib_dir, "win32traceutil.py"),
318
dest_base="tbzr_tracer")
319
console_targets.append(tracer)
322
def get_qbzr_py2exe_info(includes, excludes, packages):
323
# PyQt4 itself still escapes the plugin detection code for some reason...
324
packages.append('PyQt4')
325
excludes.append('PyQt4.elementtree.ElementTree')
326
includes.append('sip') # extension module required for Qt.
327
packages.append('pygments') # colorizer for qbzr
328
# but we can avoid many Qt4 Dlls.
330
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
331
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
332
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
333
qscintilla2.dll""".split())
334
# the qt binaries might not be on PATH...
335
qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
336
path = os.environ.get("PATH","")
337
if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
338
os.environ["PATH"] = path + os.pathsep + qt_dir
341
if 'bdist_wininst' in sys.argv:
344
for root, dirs, files in os.walk('doc'):
347
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
348
or f == 'quick-start-summary.svg'):
349
r.append(os.path.join(root, f))
353
target = os.path.join('Doc\\Bazaar', relative)
355
target = 'Doc\\Bazaar'
356
docs.append((target, r))
359
# python's distutils-based win32 installer
360
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
361
'ext_modules': ext_modules,
363
'data_files': find_docs(),
364
# for building pyrex extensions
365
'cmdclass': {'build_ext': build_ext_if_possible},
368
ARGS.update(META_INFO)
370
ARGS.update(PKG_DATA)
374
elif 'py2exe' in sys.argv:
379
# pick real bzr version
383
for i in bzrlib.version_info[:4]:
388
version_number.append(str(i))
389
version_str = '.'.join(version_number)
391
# An override to install_data used only by py2exe builds, which arranges
392
# to byte-compile any .py files in data_files (eg, our plugins)
393
# Necessary as we can't rely on the user having the relevant permissions
394
# to the "Program Files" directory to generate them on the fly.
395
class install_data_with_bytecompile(install_data):
397
from distutils.util import byte_compile
399
install_data.run(self)
401
py2exe = self.distribution.get_command_obj('py2exe', False)
402
optimize = py2exe.optimize
403
compile_names = [f for f in self.outfiles if f.endswith('.py')]
404
byte_compile(compile_names,
406
force=self.force, prefix=self.install_dir,
407
dry_run=self.dry_run)
412
self.outfiles.extend([f + suffix for f in compile_names])
413
# end of class install_data_with_bytecompile
415
target = py2exe.build_exe.Target(script = "bzr",
417
icon_resources = [(0,'bzr.ico')],
418
name = META_INFO['name'],
419
version = version_str,
420
description = META_INFO['description'],
421
author = META_INFO['author'],
422
copyright = "(c) Canonical Ltd, 2005-2007",
423
company_name = "Canonical Ltd.",
424
comments = META_INFO['description'],
427
packages = BZRLIB['packages']
428
packages.remove('bzrlib')
429
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
431
for i in glob.glob('bzrlib\\*.py'):
432
module = i[:-3].replace('\\', '.')
433
if module.endswith('__init__'):
434
module = module[:-len('__init__')]
435
includes.append(module)
437
additional_packages = set()
438
if sys.version.startswith('2.4'):
439
# adding elementtree package
440
additional_packages.add('elementtree')
441
elif sys.version.startswith('2.5'):
442
additional_packages.add('xml.etree')
445
warnings.warn('Unknown Python version.\n'
446
'Please check setup.py script for compatibility.')
448
# Although we currently can't enforce it, we consider it an error for
449
# py2exe to report any files are "missing". Such modules we know aren't
450
# used should be listed here.
451
excludes = """Tkinter psyco ElementPath r_hmac
452
ImaginaryModule cElementTree elementtree.ElementTree
453
Crypto.PublicKey._fastmath
454
medusa medusa.filesys medusa.ftp_server
455
tools tools.doc_generate
456
resource validate""".split()
459
# email package from std python library use lazy import,
460
# so we need to explicitly add all package
461
additional_packages.add('email')
462
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
463
# a result, packages like 'email.Parser' show as missing. Tell py2exe
466
for oldname in getattr(email, '_LOWERNAMES', []):
467
excludes.append("email." + oldname)
468
for oldname in getattr(email, '_MIMENAMES', []):
469
excludes.append("email.MIME" + oldname)
471
# text files for help topis
472
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
473
topics_files = [('lib/help_topics/en', text_topics)]
477
# XXX - should we consider having the concept of an 'official' build,
478
# which hard-codes the list of plugins, gets more upset if modules are
480
plugins = None # will be a set after plugin sniffing...
481
for root, dirs, files in os.walk('bzrlib/plugins'):
482
if root == 'bzrlib/plugins':
486
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll"]:
488
if i == '__init__.py' and root == 'bzrlib/plugins':
490
x.append(os.path.join(root, i))
492
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
493
plugins_files.append((target_dir, x))
494
# find modules for built-in plugins
495
import tools.package_mf
496
mf = tools.package_mf.CustomModuleFinder()
497
mf.run_package('bzrlib/plugins')
498
packs, mods = mf.get_result()
499
additional_packages.update(packs)
500
includes.extend(mods)
502
console_targets = [target,
503
'tools/win32/bzr_postinstall.py',
508
if 'qbzr' in plugins:
509
get_qbzr_py2exe_info(includes, excludes, packages)
511
if "TBZR" in os.environ:
512
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
513
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
514
# can be downloaded from (username=guest, blank password):
515
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays/version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
516
if not os.path.isfile(os.environ.get('TORTOISE_OVERLAYS_MSI_WIN32',
518
raise RuntimeError("Please set TORTOISE_OVERLAYS_MSI_WIN32 to the"
519
" location of the Win32 TortoiseOverlays .msi"
521
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
524
# print this warning to stderr as output is redirected, so it is seen
525
# at build time. Also to stdout so it appears in the log
526
for f in (sys.stderr, sys.stdout):
528
"Skipping TBZR binaries - please set TBZR to a directory to enable"
530
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
532
dll_excludes.append("MSWSOCK.dll")
533
options_list = {"py2exe": {"packages": packages + list(additional_packages),
534
"includes": includes,
535
"excludes": excludes,
536
"dll_excludes": dll_excludes,
537
"dist_dir": "win32_bzr.exe",
542
setup(options=options_list,
543
console=console_targets,
545
com_server=com_targets,
546
zipfile='lib/library.zip',
547
data_files=topics_files + plugins_files,
548
cmdclass={'install_data': install_data_with_bytecompile},
552
# ad-hoc for easy_install
554
if not 'bdist_egg' in sys.argv:
555
# generate and install bzr.1 only with plain install, not easy_install one
556
DATA_FILES = [('man/man1', ['bzr.1'])]
559
ARGS = {'scripts': ['bzr'],
560
'data_files': DATA_FILES,
561
'cmdclass': command_classes,
562
'ext_modules': ext_modules,
565
ARGS.update(META_INFO)
567
ARGS.update(PKG_DATA)