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',
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
178
from Pyrex.Compiler.Version import version as pyrex_version
181
class build_ext_if_possible(build_ext):
186
except DistutilsPlatformError, e:
188
log.warn('Extensions cannot be built, '
189
'will use the Python versions instead')
191
def build_extension(self, ext):
193
build_ext.build_extension(self, ext)
194
except CCompilerError:
195
log.warn('Building of "%s" extension failed, '
196
'will use the Python version instead' % (ext.name,))
199
# Override the build_ext if we have Pyrex available
200
command_classes['build_ext'] = build_ext_if_possible
201
unavailable_files = []
204
def add_pyrex_extension(module_name, **kwargs):
205
"""Add a pyrex module to build.
207
This will use Pyrex to auto-generate the .c file if it is available.
208
Otherwise it will fall back on the .c file. If the .c file is not
209
available, it will warn, and not add anything.
211
You can pass any extra options to Extension through kwargs. One example is
214
:param module_name: The python path to the module. This will be used to
215
determine the .pyx and .c files to use.
217
path = module_name.replace('.', '/')
218
pyrex_name = path + '.pyx'
221
ext_modules.append(Extension(module_name, [pyrex_name], **kwargs))
223
if not os.path.isfile(c_name):
224
unavailable_files.append(c_name)
226
ext_modules.append(Extension(module_name, [c_name], **kwargs))
229
add_pyrex_extension('bzrlib._btree_serializer_c')
230
add_pyrex_extension('bzrlib._knit_load_data_c')
231
if sys.platform == 'win32':
232
add_pyrex_extension('bzrlib._dirstate_helpers_c',
235
# pyrex uses the macro WIN32 to detect the platform, even though it should
236
# be using something like _WIN32 or MS_WINDOWS, oh well, we can give it the
238
add_pyrex_extension('bzrlib._walkdirs_win32',
239
define_macros=[('WIN32', None)])
241
if have_pyrex and pyrex_version == '0.9.4.1':
242
# Pyrex 0.9.4.1 fails to compile this extension correctly
243
# The code it generates re-uses a "local" pointer and
244
# calls "PY_DECREF" after having set it to NULL. (It mixes PY_XDECREF
245
# which is NULL safe with PY_DECREF which is not.)
246
print 'Cannot build extension "bzrlib._dirstate_helpers_c" using'
247
print 'your version of pyrex "%s". Please upgrade your pyrex' % (
249
print 'install. For now, the non-compiled (python) version will'
250
print 'be used instead.'
252
add_pyrex_extension('bzrlib._dirstate_helpers_c')
253
add_pyrex_extension('bzrlib._readdir_pyx')
254
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
257
if unavailable_files:
258
print 'C extension(s) not found:'
259
print ' %s' % ('\n '.join(unavailable_files),)
260
print 'The python versions will be used instead.'
264
def get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
266
packages.append('tbzrcommands')
268
# ModuleFinder can't handle runtime changes to __path__, but
269
# win32com uses them. Hook this in so win32com.shell is found.
272
import cPickle as pickle
273
for p in win32com.__path__[1:]:
274
modulefinder.AddPackagePath("win32com", p)
275
for extra in ["win32com.shell"]:
277
m = sys.modules[extra]
278
for p in m.__path__[1:]:
279
modulefinder.AddPackagePath(extra, p)
281
# TBZR points to the TBZR directory
282
tbzr_root = os.environ["TBZR"]
284
# Ensure tbzrlib itself is on sys.path
285
sys.path.append(tbzr_root)
287
# Ensure our COM "entry-point" is on sys.path
288
sys.path.append(os.path.join(tbzr_root, "shellext", "python"))
290
packages.append("tbzrlib")
292
# collect up our icons.
294
ico_root = os.path.join(tbzr_root, 'tbzrlib', 'resources')
295
icos = [] # list of (path_root, relative_ico_path)
296
# First always bzr's icon and its in the root of the bzr tree.
297
icos.append(('', 'bzr.ico'))
298
for root, dirs, files in os.walk(ico_root):
299
icos.extend([(ico_root, os.path.join(root, f)[len(ico_root)+1:])
300
for f in files if f.endswith('.ico')])
301
# allocate an icon ID for each file and the full path to the ico
302
icon_resources = [(rid, os.path.join(ico_dir, ico_name))
303
for rid, (ico_dir, ico_name) in enumerate(icos)]
304
# create a string resource with the mapping. Might as well save the
305
# runtime some effort and write a pickle.
306
# Runtime expects unicode objects with forward-slash seps.
307
fse = sys.getfilesystemencoding()
308
map_items = [(f.replace('\\', '/').decode(fse), rid)
309
for rid, (_, f) in enumerate(icos)]
310
ico_map = dict(map_items)
311
# Create a new resource type of 'ICON_MAP', and use ID=1
312
other_resources = [ ("ICON_MAP", 1, pickle.dumps(ico_map))]
314
excludes.extend("""pywin pywin.dialogs pywin.dialogs.list
315
win32ui crawler.Crawler""".split())
319
create_exe = False, # we only want a .dll
321
com_targets.append(tbzr)
323
# tbzrcache executables - a "console" version for debugging and a
324
# GUI version that is generally used.
326
script = os.path.join(tbzr_root, "Scripts", "tbzrcache.py"),
327
icon_resources = icon_resources,
328
other_resources = other_resources,
330
console_targets.append(tbzrcache)
332
# Make a windows version which is the same except for the base name.
333
tbzrcachew = tbzrcache.copy()
334
tbzrcachew["dest_base"]="tbzrcachew"
335
gui_targets.append(tbzrcachew)
337
# ditto for the tbzrcommand tool
339
script = os.path.join(tbzr_root, "Scripts", "tbzrcommand.py"),
340
icon_resources = [(0,'bzr.ico')],
342
console_targets.append(tbzrcommand)
343
tbzrcommandw = tbzrcommand.copy()
344
tbzrcommandw["dest_base"]="tbzrcommandw"
345
gui_targets.append(tbzrcommandw)
349
script = os.path.join(tbzr_root, "Scripts", "tbzrtest.py"),
351
console_targets.append(tbzrtest)
353
# A utility to see python output from the shell extension - this will
354
# die when we get a c++ extension
355
# any .py file from pywin32's win32 lib will do (other than
356
# win32traceutil itself that is)
358
win32_lib_dir = os.path.dirname(winerror.__file__)
359
tracer = dict(script = os.path.join(win32_lib_dir, "win32traceutil.py"),
360
dest_base="tbzr_tracer")
361
console_targets.append(tracer)
364
def get_qbzr_py2exe_info(includes, excludes, packages):
365
# PyQt4 itself still escapes the plugin detection code for some reason...
366
packages.append('PyQt4')
367
excludes.append('PyQt4.elementtree.ElementTree')
368
includes.append('sip') # extension module required for Qt.
369
packages.append('pygments') # colorizer for qbzr
370
packages.append('docutils') # html formatting
371
# but we can avoid many Qt4 Dlls.
373
"""QtAssistantClient4.dll QtCLucene4.dll QtDesigner4.dll
374
QtHelp4.dll QtNetwork4.dll QtOpenGL4.dll QtScript4.dll
375
QtSql4.dll QtTest4.dll QtWebKit4.dll QtXml4.dll
376
qscintilla2.dll""".split())
377
# the qt binaries might not be on PATH...
378
qt_dir = os.path.join(sys.prefix, "PyQt4", "bin")
379
path = os.environ.get("PATH","")
380
if qt_dir.lower() not in [p.lower() for p in path.split(os.pathsep)]:
381
os.environ["PATH"] = path + os.pathsep + qt_dir
384
if 'bdist_wininst' in sys.argv:
387
for root, dirs, files in os.walk('doc'):
390
if (os.path.splitext(f)[1] in ('.html','.css','.png','.pdf')
391
or f == 'quick-start-summary.svg'):
392
r.append(os.path.join(root, f))
396
target = os.path.join('Doc\\Bazaar', relative)
398
target = 'Doc\\Bazaar'
399
docs.append((target, r))
402
# python's distutils-based win32 installer
403
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
404
'ext_modules': ext_modules,
406
'data_files': find_docs(),
407
# for building pyrex extensions
408
'cmdclass': {'build_ext': build_ext_if_possible},
411
ARGS.update(META_INFO)
413
ARGS.update(PKG_DATA)
417
elif 'py2exe' in sys.argv:
422
# pick real bzr version
426
for i in bzrlib.version_info[:4]:
431
version_number.append(str(i))
432
version_str = '.'.join(version_number)
434
# An override to install_data used only by py2exe builds, which arranges
435
# to byte-compile any .py files in data_files (eg, our plugins)
436
# Necessary as we can't rely on the user having the relevant permissions
437
# to the "Program Files" directory to generate them on the fly.
438
class install_data_with_bytecompile(install_data):
440
from distutils.util import byte_compile
442
install_data.run(self)
444
py2exe = self.distribution.get_command_obj('py2exe', False)
445
optimize = py2exe.optimize
446
compile_names = [f for f in self.outfiles if f.endswith('.py')]
447
byte_compile(compile_names,
449
force=self.force, prefix=self.install_dir,
450
dry_run=self.dry_run)
455
self.outfiles.extend([f + suffix for f in compile_names])
456
# end of class install_data_with_bytecompile
458
target = py2exe.build_exe.Target(script = "bzr",
460
icon_resources = [(0,'bzr.ico')],
461
name = META_INFO['name'],
462
version = version_str,
463
description = META_INFO['description'],
464
author = META_INFO['author'],
465
copyright = "(c) Canonical Ltd, 2005-2007",
466
company_name = "Canonical Ltd.",
467
comments = META_INFO['description'],
470
packages = BZRLIB['packages']
471
packages.remove('bzrlib')
472
packages = [i for i in packages if not i.startswith('bzrlib.plugins')]
474
for i in glob.glob('bzrlib\\*.py'):
475
module = i[:-3].replace('\\', '.')
476
if module.endswith('__init__'):
477
module = module[:-len('__init__')]
478
includes.append(module)
480
additional_packages = set()
481
if sys.version.startswith('2.4'):
482
# adding elementtree package
483
additional_packages.add('elementtree')
484
elif sys.version.startswith('2.5'):
485
additional_packages.add('xml.etree')
488
warnings.warn('Unknown Python version.\n'
489
'Please check setup.py script for compatibility.')
491
# Although we currently can't enforce it, we consider it an error for
492
# py2exe to report any files are "missing". Such modules we know aren't
493
# used should be listed here.
494
excludes = """Tkinter psyco ElementPath r_hmac
495
ImaginaryModule cElementTree elementtree.ElementTree
496
Crypto.PublicKey._fastmath
497
medusa medusa.filesys medusa.ftp_server
498
tools tools.doc_generate
499
resource validate""".split()
502
# email package from std python library use lazy import,
503
# so we need to explicitly add all package
504
additional_packages.add('email')
505
# And it uses funky mappings to conver to 'Oldname' to 'newname'. As
506
# a result, packages like 'email.Parser' show as missing. Tell py2exe
509
for oldname in getattr(email, '_LOWERNAMES', []):
510
excludes.append("email." + oldname)
511
for oldname in getattr(email, '_MIMENAMES', []):
512
excludes.append("email.MIME" + oldname)
514
# text files for help topis
515
text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
516
topics_files = [('lib/help_topics/en', text_topics)]
520
# XXX - should we consider having the concept of an 'official' build,
521
# which hard-codes the list of plugins, gets more upset if modules are
523
plugins = None # will be a set after plugin sniffing...
524
for root, dirs, files in os.walk('bzrlib/plugins'):
525
if root == 'bzrlib/plugins':
529
if os.path.splitext(i)[1] not in [".py", ".pyd", ".dll", ".mo"]:
531
if i == '__init__.py' and root == 'bzrlib/plugins':
533
x.append(os.path.join(root, i))
535
target_dir = root[len('bzrlib/'):] # install to 'plugins/...'
536
plugins_files.append((target_dir, x))
537
# find modules for built-in plugins
538
import tools.package_mf
539
mf = tools.package_mf.CustomModuleFinder()
540
mf.run_package('bzrlib/plugins')
541
packs, mods = mf.get_result()
542
additional_packages.update(packs)
543
includes.extend(mods)
545
console_targets = [target,
546
'tools/win32/bzr_postinstall.py',
551
if 'qbzr' in plugins:
552
get_qbzr_py2exe_info(includes, excludes, packages)
554
if "TBZR" in os.environ:
555
# TORTOISE_OVERLAYS_MSI_WIN32 must be set to the location of the
556
# TortoiseOverlays MSI installer file. It is in the TSVN svn repo and
557
# can be downloaded from (username=guest, blank password):
558
# http://tortoisesvn.tigris.org/svn/tortoisesvn/TortoiseOverlays/version-1.0.4/bin/TortoiseOverlays-1.0.4.11886-win32.msi
559
if not os.path.isfile(os.environ.get('TORTOISE_OVERLAYS_MSI_WIN32',
561
raise RuntimeError("Please set TORTOISE_OVERLAYS_MSI_WIN32 to the"
562
" location of the Win32 TortoiseOverlays .msi"
564
get_tbzr_py2exe_info(includes, excludes, packages, console_targets,
567
# print this warning to stderr as output is redirected, so it is seen
568
# at build time. Also to stdout so it appears in the log
569
for f in (sys.stderr, sys.stdout):
571
"Skipping TBZR binaries - please set TBZR to a directory to enable"
573
# MSWSOCK.dll is a system-specific library, which py2exe accidentally pulls
575
dll_excludes.append("MSWSOCK.dll")
576
options_list = {"py2exe": {"packages": packages + list(additional_packages),
577
"includes": includes,
578
"excludes": excludes,
579
"dll_excludes": dll_excludes,
580
"dist_dir": "win32_bzr.exe",
585
setup(options=options_list,
586
console=console_targets,
588
com_server=com_targets,
589
zipfile='lib/library.zip',
590
data_files=topics_files + plugins_files,
591
cmdclass={'install_data': install_data_with_bytecompile},
595
# ad-hoc for easy_install
597
if not 'bdist_egg' in sys.argv:
598
# generate and install bzr.1 only with plain install, not easy_install one
599
DATA_FILES = [('man/man1', ['bzr.1'])]
602
ARGS = {'scripts': ['bzr'],
603
'data_files': DATA_FILES,
604
'cmdclass': command_classes,
605
'ext_modules': ext_modules,
608
ARGS.update(META_INFO)
610
ARGS.update(PKG_DATA)
added
removed
setup.py
