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