~bzr-pqm/bzr/bzr.dev

45 by Martin Pool
- add setup.py and install instructions
1
#! /usr/bin/env python
2
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
3
"""Installation script for bzr.
4
Run it with
5
 './setup.py install', or
6
 './setup.py --help' for more options
7
"""
8
1930.3.1 by John Arbash Meinel
Change setup.py to auto-generate the list of packages to install
9
import os
10
import sys
11
1861.2.21 by Alexander Belchenko
setup.py: automatically grab version info from bzrlib
12
import bzrlib
13
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
14
##
15
# META INFORMATION FOR SETUP
16
17
META_INFO = {'name':         'bzr',
1861.2.21 by Alexander Belchenko
setup.py: automatically grab version info from bzrlib
18
             'version':      bzrlib.__version__,
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
19
             'author':       'Canonical Ltd',
2234.5.1 by Wouter van Heyst
Update the mailing list address.
20
             'author_email': 'bazaar@lists.canonical.com',
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
21
             'url':          'http://www.bazaar-vcs.org/',
22
             'description':  'Friendly distributed version control system',
23
             'license':      'GNU GPL v2',
24
            }
25
1930.3.3 by John Arbash Meinel
Fix a stupid error in code declaration order
26
# The list of packages is automatically generated later. Add other things
27
# that are part of BZRLIB here.
28
BZRLIB = {}
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
29
1911.1.1 by Alexander Belchenko
setup.py: need to install data files for selftest from bzrlib/tests/test_patched_data
30
PKG_DATA = {# install files from selftest suite
31
            'package_data': {'bzrlib': ['doc/api/*.txt',
32
                                        'tests/test_patches_data/*',
33
                                       ]},
34
           }
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
35
1861.2.12 by Alexander Belchenko
setup.py: get version info from bzrlib
36
######################################################################
1185.29.5 by Wouter van Heyst
Add reinvocation code to ensure setup.py is run by python2.4
37
# Reinvocation stolen from bzr, we need python2.4 by virtue of bzr_man
38
# including bzrlib.help
39
40
try:
41
    version_info = sys.version_info
42
except AttributeError:
43
    version_info = 1, 5 # 1.5 or older
44
45
REINVOKE = "__BZR_REINVOKE"
46
NEED_VERS = (2, 4)
47
KNOWN_PYTHONS = ('python2.4',)
48
49
if version_info < NEED_VERS:
50
    if not os.environ.has_key(REINVOKE):
51
        # mutating os.environ doesn't work in old Pythons
52
        os.putenv(REINVOKE, "1")
53
        for python in KNOWN_PYTHONS:
54
            try:
55
                os.execvp(python, [python] + sys.argv)
56
            except OSError:
57
                pass
58
    print >>sys.stderr, "bzr: error: cannot find a suitable python interpreter"
59
    print >>sys.stderr, "  (need %d.%d or later)" % NEED_VERS
60
    sys.exit(1)
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
61
if getattr(os, "unsetenv", None) is not None:
1185.29.5 by Wouter van Heyst
Add reinvocation code to ensure setup.py is run by python2.4
62
    os.unsetenv(REINVOKE)
63
64
1930.3.1 by John Arbash Meinel
Change setup.py to auto-generate the list of packages to install
65
def get_bzrlib_packages():
66
    """Recurse through the bzrlib directory, and extract the package names"""
67
68
    packages = []
69
    base_path = os.path.dirname(os.path.abspath(bzrlib.__file__))
70
    for root, dirs, files in os.walk(base_path):
71
        if '__init__.py' in files:
72
            assert root.startswith(base_path)
73
            # Get just the path below bzrlib
74
            package_path = root[len(base_path):]
75
            # Remove leading and trailing slashes
76
            package_path = package_path.strip('\\/')
77
            if not package_path:
78
                package_name = 'bzrlib'
79
            else:
80
                package_name = ('bzrlib.' +
81
                            package_path.replace('/', '.').replace('\\', '.'))
82
            packages.append(package_name)
83
    return sorted(packages)
84
85
1930.3.3 by John Arbash Meinel
Fix a stupid error in code declaration order
86
BZRLIB['packages'] = get_bzrlib_packages()
87
88
45 by Martin Pool
- add setup.py and install instructions
89
from distutils.core import setup
1185.23.1 by Aaron Bentley
win32 setup fixes from Belchenko
90
from distutils.command.install_scripts import install_scripts
1185.29.3 by Wouter van Heyst
Create bzr.1 manpage from setup.py
91
from distutils.command.build import build
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
92
93
###############################
94
# Overridden distutils actions
95
###############################
96
1185.23.1 by Aaron Bentley
win32 setup fixes from Belchenko
97
class my_install_scripts(install_scripts):
98
    """ Customized install_scripts distutils action.
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
99
    Create bzr.bat for win32.
100
    """
101
    def run(self):
1185.23.1 by Aaron Bentley
win32 setup fixes from Belchenko
102
        install_scripts.run(self)   # standard action
103
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
104
        if sys.platform == "win32":
1185.23.1 by Aaron Bentley
win32 setup fixes from Belchenko
105
            try:
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
106
                scripts_dir = os.path.join(sys.prefix, 'Scripts')
1861.2.10 by Alexander Belchenko
setup.py: improved bzr.bat creation
107
                script_path = self._quoted_path(os.path.join(scripts_dir,
108
                                                             "bzr"))
109
                python_exe = self._quoted_path(sys.executable)
110
                args = self._win_batch_args()
111
                batch_str = "@%s %s %s" % (python_exe, script_path, args)
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
112
                batch_path = os.path.join(self.install_dir, "bzr.bat")
1185.23.1 by Aaron Bentley
win32 setup fixes from Belchenko
113
                f = file(batch_path, "w")
114
                f.write(batch_str)
115
                f.close()
116
                print "Created:", batch_path
117
            except Exception, e:
118
                print "ERROR: Unable to create %s: %s" % (batch_path, e)
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
119
1861.2.10 by Alexander Belchenko
setup.py: improved bzr.bat creation
120
    def _quoted_path(self, path):
121
        if ' ' in path:
122
            return '"' + path + '"'
123
        else:
124
            return path
125
126
    def _win_batch_args(self):
2245.4.4 by Alexander Belchenko
setup.py: fix plain 'python setup.py install' for win98
127
        from bzrlib.win32utils import winver
128
        if winver == 'Windows NT':
1861.2.10 by Alexander Belchenko
setup.py: improved bzr.bat creation
129
            return '%*'
130
        else:
131
            return '%1 %2 %3 %4 %5 %6 %7 %8 %9'
132
#/class my_install_scripts
133
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
134
1185.29.3 by Wouter van Heyst
Create bzr.1 manpage from setup.py
135
class bzr_build(build):
136
    """Customized build distutils action.
137
    Generate bzr.1.
138
    """
139
    def run(self):
140
        build.run(self)
141
1551.3.11 by Aaron Bentley
Merge from Robert
142
        import generate_docs
143
        generate_docs.main(argv=["bzr", "man"])
1185.29.3 by Wouter van Heyst
Create bzr.1 manpage from setup.py
144
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
145
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
146
########################
147
## Setup
148
########################
149
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
150
command_classes = {'install_scripts': my_install_scripts,
2571.3.1 by Alexander Belchenko
Building Python-based installer for bot Python 2.4 and 2.5
151
                   'build': bzr_build}
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
152
from distutils import log
2814.4.2 by Alexander Belchenko
support for win32
153
from distutils.errors import CCompilerError, DistutilsPlatformError
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
154
from distutils.extension import Extension
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
155
ext_modules = []
156
try:
157
    from Pyrex.Distutils import build_ext
158
except ImportError:
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
159
    have_pyrex = False
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
160
    # try to build the extension from the prior generated source.
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
161
    print
2617.1.2 by John Arbash Meinel
Try another form of comment
162
    print ("The python package 'Pyrex' is not available."
163
           " If the .c files are available,")
164
    print ("they will be built,"
165
           " but modifying the .pyx files will not rebuild them.")
2617.1.3 by John Arbash Meinel
Add another blank line to make it show up better
166
    print
1739.1.4 by Robert Collins
Fix building of C modules without pyrex installed.
167
    from distutils.command.build_ext import build_ext
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
168
else:
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
169
    have_pyrex = True
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
170
171
172
class build_ext_if_possible(build_ext):
173
2814.4.2 by Alexander Belchenko
support for win32
174
    def run(self):
175
        try:
176
            build_ext.run(self)
177
        except DistutilsPlatformError, e:
2814.4.4 by Alexander Belchenko
changes suggested by Aaron and Martin
178
            log.warn(str(e))
2814.4.5 by Alexander Belchenko
double quotes for extension name
179
            log.warn('Extensions cannot be built, '
180
                     'will use the Python versions instead')
2814.4.2 by Alexander Belchenko
support for win32
181
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
182
    def build_extension(self, ext):
183
        try:
184
            build_ext.build_extension(self, ext)
185
        except CCompilerError:
2814.4.5 by Alexander Belchenko
double quotes for extension name
186
            log.warn('Building of "%s" extension failed, '
187
                     'will use the Python version instead' % (ext.name,))
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
188
189
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
190
# Override the build_ext if we have Pyrex available
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
191
command_classes['build_ext'] = build_ext_if_possible
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
192
unavailable_files = []
193
2617.1.2 by John Arbash Meinel
Try another form of comment
194
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
195
def add_pyrex_extension(module_name, **kwargs):
196
    """Add a pyrex module to build.
197
198
    This will use Pyrex to auto-generate the .c file if it is available.
199
    Otherwise it will fall back on the .c file. If the .c file is not
200
    available, it will warn, and not add anything.
201
202
    You can pass any extra options to Extension through kwargs. One example is
203
    'libraries = []'.
204
205
    :param module_name: The python path to the module. This will be used to
206
        determine the .pyx and .c files to use.
207
    """
208
    path = module_name.replace('.', '/')
209
    pyrex_name = path + '.pyx'
210
    c_name = path + '.c'
211
    if have_pyrex:
212
        ext_modules.append(Extension(module_name, [pyrex_name]))
213
    else:
214
        if not os.path.isfile(c_name):
215
            unavailable_files.append(c_name)
216
        else:
217
            ext_modules.append(Extension(module_name, [c_name]))
218
219
2474.1.71 by John Arbash Meinel
[merge] bzr.dev 2625
220
add_pyrex_extension('bzrlib._dirstate_helpers_c')
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
221
add_pyrex_extension('bzrlib._knit_load_data_c')
2781.1.1 by Martin Pool
merge cpatiencediff from Lukas
222
ext_modules.append(Extension('bzrlib._patiencediff_c', ['bzrlib/_patiencediff_c.c']))
2617.1.1 by John Arbash Meinel
Update setup.py to just skip extensions that are not available.
223
224
225
if unavailable_files:
226
    print 'C extension(s) not found:'
227
    print '   %s' % ('\n  '.join(unavailable_files),)
228
    print 'The python versions will be used instead.'
229
    print
230
1739.1.1 by Robert Collins
First cut at adding pyrex facilities.
231
1860.1.2 by Alexander Belchenko
setup.py:
232
if 'bdist_wininst' in sys.argv:
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
233
    def find_docs():
234
        docs = []
235
        for root, dirs, files in os.walk('doc'):
236
            r = []
237
            for f in files:
2691.1.19 by Alexander Belchenko
setup.py find_docs() without fnmatch
238
                if os.path.splitext(f)[1] in ('.html', '.css'):
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
239
                    r.append(os.path.join(root, f))
240
            if r:
241
                relative = root[4:]
242
                if relative:
243
                    target = os.path.join('Doc\\Bazaar', relative)
244
                else:
245
                    target = 'Doc\\Bazaar'
246
                docs.append((target, r))
247
        return docs
248
1860.1.2 by Alexander Belchenko
setup.py:
249
    # python's distutils-based win32 installer
250
    ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
2571.3.1 by Alexander Belchenko
Building Python-based installer for bot Python 2.4 and 2.5
251
            'ext_modules': ext_modules,
1860.1.3 by Alexander Belchenko
python-installer:
252
            # help pages
2691.1.18 by Alexander Belchenko
teach windows python installer to find docs in all subdirectories
253
            'data_files': find_docs(),
2571.3.1 by Alexander Belchenko
Building Python-based installer for bot Python 2.4 and 2.5
254
            # for building pyrex extensions
2814.4.1 by Lukáš Lalinský
Don't abort ``python setup.py install`` if building of a C extension is not possible.
255
            'cmdclass': {'build_ext': build_ext_if_possible},
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
256
           }
1821.1.2 by Alexander Belchenko
resurrected python's distutils based installer for win32
257
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
258
    ARGS.update(META_INFO)
259
    ARGS.update(BZRLIB)
1911.1.1 by Alexander Belchenko
setup.py: need to install data files for selftest from bzrlib/tests/test_patched_data
260
    ARGS.update(PKG_DATA)
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
261
    
262
    setup(**ARGS)
263
1860.1.2 by Alexander Belchenko
setup.py:
264
elif 'py2exe' in sys.argv:
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
265
    # py2exe setup
266
    import py2exe
267
268
    # pick real bzr version
269
    import bzrlib
270
271
    version_number = []
272
    for i in bzrlib.version_info[:4]:
273
        try:
274
            i = int(i)
275
        except ValueError:
276
            i = 0
277
        version_number.append(str(i))
278
    version_str = '.'.join(version_number)
279
280
    target = py2exe.build_exe.Target(script = "bzr",
281
                                     dest_base = "bzr",
282
                                     icon_resources = [(0,'bzr.ico')],
283
                                     name = META_INFO['name'],
284
                                     version = version_str,
285
                                     description = META_INFO['description'],
286
                                     author = META_INFO['author'],
2232.1.1 by mbp at sourcefrog
update global copyright to 2007
287
                                     copyright = "(c) Canonical Ltd, 2005-2007",
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
288
                                     company_name = "Canonical Ltd.",
289
                                     comments = META_INFO['description'],
290
                                    )
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
291
292
    additional_packages =  []
293
    if sys.version.startswith('2.4'):
294
        # adding elementtree package
295
        additional_packages.append('elementtree')
2234.5.2 by Wouter van Heyst
(Alexander Belchenko) add windows installer check for python2.5
296
    elif sys.version.startswith('2.5'):
297
        additional_packages.append('xml.etree')
298
    else:
299
        import warnings
300
        warnings.warn('Unknown Python version.\n'
301
                      'Please check setup.py script for compatibility.')
2571.3.2 by Alexander Belchenko
Build pyrex/C extensions for bzr.exe
302
    # email package from std python library use lazy import,
303
    # so we need to explicitly add all package
304
    additional_packages.append('email')
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
305
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
306
    options_list = {"py2exe": {"packages": BZRLIB['packages'] +
2231.1.1 by Alexander Belchenko
Python 2.5 fixes for win32 installer
307
                                           additional_packages,
2481.2.1 by Alexander Belchenko
don't bundle into standalone bzr.exe site.py (with their depends), and tools/doc_generate
308
                               "excludes": ["Tkinter", "medusa", "tools"],
1821.1.1 by Alexander Belchenko
win32 installer for bzr.dev.0.9
309
                               "dist_dir": "win32_bzr.exe",
310
                              },
311
                   }
312
    setup(options=options_list,
313
          console=[target,
314
                   'tools/win32/bzr_postinstall.py',
315
                  ],
316
          zipfile='lib/library.zip')
1860.1.2 by Alexander Belchenko
setup.py:
317
318
else:
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
319
    # ad-hoc for easy_install
320
    DATA_FILES = []
321
    if not 'bdist_egg' in sys.argv:
322
        # generate and install bzr.1 only with plain install, not easy_install one
323
        DATA_FILES = [('man/man1', ['bzr.1'])]
324
1860.1.2 by Alexander Belchenko
setup.py:
325
    # std setup
326
    ARGS = {'scripts': ['bzr'],
2662.1.1 by Alexander Belchenko
allow ``easy_install bzr`` runs without fatal errors. (Alexander Belchenko, #125521)
327
            'data_files': DATA_FILES,
1739.1.3 by Robert Collins
Merge bzr.dev.
328
            'cmdclass': command_classes,
329
            'ext_modules': ext_modules,
1860.1.2 by Alexander Belchenko
setup.py:
330
           }
2666.2.1 by Alexander Belchenko
change generated documentation extension from htm to html
331
1860.1.2 by Alexander Belchenko
setup.py:
332
    ARGS.update(META_INFO)
333
    ARGS.update(BZRLIB)
1911.1.1 by Alexander Belchenko
setup.py: need to install data files for selftest from bzrlib/tests/test_patched_data
334
    ARGS.update(PKG_DATA)
1860.1.2 by Alexander Belchenko
setup.py:
335
336
    setup(**ARGS)