##// END OF EJS Templates
Merge pull request #1301 from nathan-rice/master...
Fernando Perez -
r5936:005dc7c9 merge
parent child Browse files
Show More
@@ -1,286 +1,287 b''
1 1 #!/usr/bin/env python
2 2 # -*- coding: utf-8 -*-
3 3 """Setup script for IPython.
4 4
5 5 Under Posix environments it works like a typical setup.py script.
6 6 Under Windows, the command sdist is not supported, since IPython
7 7 requires utilities which are not available under Windows."""
8 8
9 9 #-----------------------------------------------------------------------------
10 10 # Copyright (c) 2008-2011, IPython Development Team.
11 11 # Copyright (c) 2001-2007, Fernando Perez <fernando.perez@colorado.edu>
12 12 # Copyright (c) 2001, Janko Hauser <jhauser@zscout.de>
13 13 # Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu>
14 14 #
15 15 # Distributed under the terms of the Modified BSD License.
16 16 #
17 17 # The full license is in the file COPYING.txt, distributed with this software.
18 18 #-----------------------------------------------------------------------------
19 19
20 20 #-----------------------------------------------------------------------------
21 21 # Minimal Python version sanity check
22 22 #-----------------------------------------------------------------------------
23 23 from __future__ import print_function
24 24
25 25 import sys
26 26
27 27 # This check is also made in IPython/__init__, don't forget to update both when
28 28 # changing Python version requirements.
29 29 #~ if sys.version[0:3] < '2.6':
30 30 #~ error = """\
31 31 #~ ERROR: 'IPython requires Python Version 2.6 or above.'
32 32 #~ Exiting."""
33 33 #~ print >> sys.stderr, error
34 34 #~ sys.exit(1)
35 35
36 36 PY3 = (sys.version_info[0] >= 3)
37 37
38 38 # At least we're on the python version we need, move on.
39 39
40 40 #-------------------------------------------------------------------------------
41 41 # Imports
42 42 #-------------------------------------------------------------------------------
43 43
44 44 # Stdlib imports
45 45 import os
46 46 import shutil
47 47
48 48 from glob import glob
49 49
50 50 # BEFORE importing distutils, remove MANIFEST. distutils doesn't properly
51 51 # update it when the contents of directories change.
52 52 if os.path.exists('MANIFEST'): os.remove('MANIFEST')
53 53
54 54 from distutils.core import setup
55 55
56 56 # On Python 3, we need distribute (new setuptools) to do the 2to3 conversion
57 57 if PY3:
58 58 import setuptools
59 59
60 60 # Our own imports
61 61 from setupbase import target_update
62 62
63 63 from setupbase import (
64 64 setup_args,
65 65 find_packages,
66 66 find_package_data,
67 67 find_scripts,
68 68 find_data_files,
69 69 check_for_dependencies,
70 70 record_commit_info,
71 71 )
72 72 from setupext import setupext
73 73
74 74 isfile = os.path.isfile
75 75 pjoin = os.path.join
76 76
77 77 #-----------------------------------------------------------------------------
78 78 # Function definitions
79 79 #-----------------------------------------------------------------------------
80 80
81 81 def cleanup():
82 82 """Clean up the junk left around by the build process"""
83 83 if "develop" not in sys.argv:
84 84 try:
85 85 shutil.rmtree('ipython.egg-info')
86 86 except:
87 87 try:
88 88 os.unlink('ipython.egg-info')
89 89 except:
90 90 pass
91 91
92 92 #-------------------------------------------------------------------------------
93 93 # Handle OS specific things
94 94 #-------------------------------------------------------------------------------
95 95
96 96 if os.name == 'posix':
97 97 os_name = 'posix'
98 98 elif os.name in ['nt','dos']:
99 99 os_name = 'windows'
100 100 else:
101 101 print('Unsupported operating system:',os.name)
102 102 sys.exit(1)
103 103
104 104 # Under Windows, 'sdist' has not been supported. Now that the docs build with
105 105 # Sphinx it might work, but let's not turn it on until someone confirms that it
106 106 # actually works.
107 107 if os_name == 'windows' and 'sdist' in sys.argv:
108 108 print('The sdist command is not available under Windows. Exiting.')
109 109 sys.exit(1)
110 110
111 111 #-------------------------------------------------------------------------------
112 112 # Things related to the IPython documentation
113 113 #-------------------------------------------------------------------------------
114 114
115 115 # update the manuals when building a source dist
116 116 if len(sys.argv) >= 2 and sys.argv[1] in ('sdist','bdist_rpm'):
117 117 import textwrap
118 118
119 119 # List of things to be updated. Each entry is a triplet of args for
120 120 # target_update()
121 121 to_update = [
122 122 # FIXME - Disabled for now: we need to redo an automatic way
123 123 # of generating the magic info inside the rst.
124 124 #('docs/magic.tex',
125 125 #['IPython/Magic.py'],
126 126 #"cd doc && ./update_magic.sh" ),
127 127
128 128 ('docs/man/ipcluster.1.gz',
129 129 ['docs/man/ipcluster.1'],
130 130 'cd docs/man && gzip -9c ipcluster.1 > ipcluster.1.gz'),
131 131
132 132 ('docs/man/ipcontroller.1.gz',
133 133 ['docs/man/ipcontroller.1'],
134 134 'cd docs/man && gzip -9c ipcontroller.1 > ipcontroller.1.gz'),
135 135
136 136 ('docs/man/ipengine.1.gz',
137 137 ['docs/man/ipengine.1'],
138 138 'cd docs/man && gzip -9c ipengine.1 > ipengine.1.gz'),
139 139
140 140 ('docs/man/iplogger.1.gz',
141 141 ['docs/man/iplogger.1'],
142 142 'cd docs/man && gzip -9c iplogger.1 > iplogger.1.gz'),
143 143
144 144 ('docs/man/ipython.1.gz',
145 145 ['docs/man/ipython.1'],
146 146 'cd docs/man && gzip -9c ipython.1 > ipython.1.gz'),
147 147
148 148 ('docs/man/irunner.1.gz',
149 149 ['docs/man/irunner.1'],
150 150 'cd docs/man && gzip -9c irunner.1 > irunner.1.gz'),
151 151
152 152 ('docs/man/pycolor.1.gz',
153 153 ['docs/man/pycolor.1'],
154 154 'cd docs/man && gzip -9c pycolor.1 > pycolor.1.gz'),
155 155 ]
156 156
157 157 # Only build the docs if sphinx is present
158 158 try:
159 159 import sphinx
160 160 except ImportError:
161 161 pass
162 162 else:
163 163 # The Makefile calls the do_sphinx scripts to build html and pdf, so
164 164 # just one target is enough to cover all manual generation
165 165
166 166 # First, compute all the dependencies that can force us to rebuild the
167 167 # docs. Start with the main release file that contains metadata
168 168 docdeps = ['IPython/core/release.py']
169 169 # Inculde all the reST sources
170 170 pjoin = os.path.join
171 171 for dirpath,dirnames,filenames in os.walk('docs/source'):
172 172 if dirpath in ['_static','_templates']:
173 173 continue
174 174 docdeps += [ pjoin(dirpath,f) for f in filenames
175 175 if f.endswith('.txt') ]
176 176 # and the examples
177 177 for dirpath,dirnames,filenames in os.walk('docs/example'):
178 178 docdeps += [ pjoin(dirpath,f) for f in filenames
179 179 if not f.endswith('~') ]
180 180 # then, make them all dependencies for the main html docs
181 181 to_update.append(
182 182 ('docs/dist/index.html',
183 183 docdeps,
184 184 "cd docs && make dist")
185 185 )
186 186
187 187 [ target_update(*t) for t in to_update ]
188 188
189 189 #---------------------------------------------------------------------------
190 190 # Find all the packages, package data, and data_files
191 191 #---------------------------------------------------------------------------
192 192
193 193 packages = find_packages()
194 194 package_data = find_package_data()
195 195 data_files = find_data_files()
196 196
197 197 setup_args['cmdclass'] = {'build_py': record_commit_info('IPython')}
198 198 setup_args['packages'] = packages
199 199 setup_args['package_data'] = package_data
200 200 setup_args['data_files'] = data_files
201 201
202 202 #---------------------------------------------------------------------------
203 203 # Handle scripts, dependencies, and setuptools specific things
204 204 #---------------------------------------------------------------------------
205 205
206 206 # For some commands, use setuptools. Note that we do NOT list install here!
207 207 # If you want a setuptools-enhanced install, just run 'setupegg.py install'
208 208 needs_setuptools = set(('develop', 'release', 'bdist_egg', 'bdist_rpm',
209 209 'bdist', 'bdist_dumb', 'bdist_wininst', 'install_egg_info',
210 210 'egg_info', 'easy_install', 'upload',
211 211 ))
212 212 if sys.platform == 'win32':
213 213 # Depend on setuptools for install on *Windows only*
214 214 # If we get script-installation working without setuptools,
215 215 # then we can back off, but until then use it.
216 216 # See Issue #369 on GitHub for more
217 217 needs_setuptools.add('install')
218 218
219 219 if len(needs_setuptools.intersection(sys.argv)) > 0:
220 220 import setuptools
221 221
222 222 # This dict is used for passing extra arguments that are setuptools
223 223 # specific to setup
224 224 setuptools_extra_args = {}
225 225
226 226 if 'setuptools' in sys.modules:
227 227 setuptools_extra_args['zip_safe'] = False
228 228 setuptools_extra_args['entry_points'] = find_scripts(True)
229 229 setup_args['extras_require'] = dict(
230 230 parallel = 'pyzmq>=2.1.4',
231 231 zmq = 'pyzmq>=2.1.4',
232 232 doc = 'Sphinx>=0.3',
233 233 test = 'nose>=0.10.1',
234 234 notebook = 'tornado>=2.0'
235 235 )
236 236 requires = setup_args.setdefault('install_requires', [])
237 237 setupext.display_status = False
238 238 if not setupext.check_for_readline():
239 239 if sys.platform == 'darwin':
240 240 requires.append('readline')
241 elif sys.platform.startswith('win') and sys.maxsize < 2**32:
242 # only require pyreadline on 32b Windows, due to 64b bug in pyreadline:
243 # https://bugs.launchpad.net/pyreadline/+bug/787574
244 requires.append('pyreadline')
241 elif sys.platform.startswith('win'):
242 # Pyreadline 64 bit windows issue solved in versions >=1.7.1
243 # Also solves issues with some older versions of pyreadline that
244 # satisfy the unconstrained depdendency.
245 requires.append('pyreadline>=1.7.1')
245 246 else:
246 247 pass
247 248 # do we want to install readline here?
248 249
249 250 # Script to be run by the windows binary installer after the default setup
250 251 # routine, to add shortcuts and similar windows-only things. Windows
251 252 # post-install scripts MUST reside in the scripts/ dir, otherwise distutils
252 253 # doesn't find them.
253 254 if 'bdist_wininst' in sys.argv:
254 255 if len(sys.argv) > 2 and \
255 256 ('sdist' in sys.argv or 'bdist_rpm' in sys.argv):
256 257 print >> sys.stderr, "ERROR: bdist_wininst must be run alone. Exiting."
257 258 sys.exit(1)
258 259 setup_args['scripts'] = [pjoin('scripts','ipython_win_post_install.py')]
259 260 setup_args['options'] = {"bdist_wininst":
260 261 {"install_script":
261 262 "ipython_win_post_install.py"}}
262 263
263 264 if PY3:
264 265 setuptools_extra_args['use_2to3'] = True
265 266 from setuptools.command.build_py import build_py
266 267 setup_args['cmdclass'] = {'build_py': record_commit_info('IPython', build_cmd=build_py)}
267 268 setuptools_extra_args['entry_points'] = find_scripts(True, suffix='3')
268 269 else:
269 270 # If we are running without setuptools, call this function which will
270 271 # check for dependencies an inform the user what is needed. This is
271 272 # just to make life easy for users.
272 273 check_for_dependencies()
273 274 setup_args['scripts'] = find_scripts(False)
274 275
275 276 #---------------------------------------------------------------------------
276 277 # Do the actual setup now
277 278 #---------------------------------------------------------------------------
278 279
279 280 setup_args.update(setuptools_extra_args)
280 281
281 282 def main():
282 283 setup(**setup_args)
283 284 cleanup()
284 285
285 286 if __name__ == '__main__':
286 287 main()
General Comments 0
You need to be logged in to leave comments. Login now