Show More
@@ -1,355 +1,349 b'' | |||||
1 | #!/usr/bin/env python |
|
1 | #!/usr/bin/env python | |
2 | # -*- coding: utf-8 -*- |
|
2 | # -*- coding: utf-8 -*- | |
3 | """Setup script for IPython. |
|
3 | """Setup script for IPython. | |
4 |
|
4 | |||
5 | Under Posix environments it works like a typical setup.py script. |
|
5 | Under Posix environments it works like a typical setup.py script. | |
6 | Under Windows, the command sdist is not supported, since IPython |
|
6 | Under Windows, the command sdist is not supported, since IPython | |
7 | requires utilities which are not available under Windows.""" |
|
7 | requires utilities which are not available under Windows.""" | |
8 |
|
8 | |||
9 | #----------------------------------------------------------------------------- |
|
9 | #----------------------------------------------------------------------------- | |
10 | # Copyright (c) 2008-2011, IPython Development Team. |
|
10 | # Copyright (c) 2008-2011, IPython Development Team. | |
11 | # Copyright (c) 2001-2007, Fernando Perez <fernando.perez@colorado.edu> |
|
11 | # Copyright (c) 2001-2007, Fernando Perez <fernando.perez@colorado.edu> | |
12 | # Copyright (c) 2001, Janko Hauser <jhauser@zscout.de> |
|
12 | # Copyright (c) 2001, Janko Hauser <jhauser@zscout.de> | |
13 | # Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu> |
|
13 | # Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu> | |
14 | # |
|
14 | # | |
15 | # Distributed under the terms of the Modified BSD License. |
|
15 | # Distributed under the terms of the Modified BSD License. | |
16 | # |
|
16 | # | |
17 | # The full license is in the file COPYING.rst, distributed with this software. |
|
17 | # The full license is in the file COPYING.rst, distributed with this software. | |
18 | #----------------------------------------------------------------------------- |
|
18 | #----------------------------------------------------------------------------- | |
19 |
|
19 | |||
20 | #----------------------------------------------------------------------------- |
|
20 | #----------------------------------------------------------------------------- | |
21 | # Minimal Python version sanity check |
|
21 | # Minimal Python version sanity check | |
22 | #----------------------------------------------------------------------------- |
|
22 | #----------------------------------------------------------------------------- | |
23 | from __future__ import print_function |
|
23 | from __future__ import print_function | |
24 |
|
24 | |||
25 | import sys |
|
25 | import sys | |
26 |
|
26 | |||
27 | # This check is also made in IPython/__init__, don't forget to update both when |
|
27 | # This check is also made in IPython/__init__, don't forget to update both when | |
28 | # changing Python version requirements. |
|
28 | # changing Python version requirements. | |
29 | v = sys.version_info |
|
29 | v = sys.version_info | |
30 | if v[:2] < (2,7) or (v[0] >= 3 and v[:2] < (3,3)): |
|
30 | if v[:2] < (2,7) or (v[0] >= 3 and v[:2] < (3,3)): | |
31 | error = "ERROR: IPython requires Python version 2.7 or 3.3 or above." |
|
31 | error = "ERROR: IPython requires Python version 2.7 or 3.3 or above." | |
32 | print(error, file=sys.stderr) |
|
32 | print(error, file=sys.stderr) | |
33 | sys.exit(1) |
|
33 | sys.exit(1) | |
34 |
|
34 | |||
35 | PY3 = (sys.version_info[0] >= 3) |
|
35 | PY3 = (sys.version_info[0] >= 3) | |
36 |
|
36 | |||
37 | # At least we're on the python version we need, move on. |
|
37 | # At least we're on the python version we need, move on. | |
38 |
|
38 | |||
39 | #------------------------------------------------------------------------------- |
|
39 | #------------------------------------------------------------------------------- | |
40 | # Imports |
|
40 | # Imports | |
41 | #------------------------------------------------------------------------------- |
|
41 | #------------------------------------------------------------------------------- | |
42 |
|
42 | |||
43 | # Stdlib imports |
|
43 | # Stdlib imports | |
44 | import os |
|
44 | import os | |
45 | import shutil |
|
45 | import shutil | |
46 |
|
46 | |||
47 | from glob import glob |
|
47 | from glob import glob | |
48 |
|
48 | |||
49 | # BEFORE importing distutils, remove MANIFEST. distutils doesn't properly |
|
49 | # BEFORE importing distutils, remove MANIFEST. distutils doesn't properly | |
50 | # update it when the contents of directories change. |
|
50 | # update it when the contents of directories change. | |
51 | if os.path.exists('MANIFEST'): os.remove('MANIFEST') |
|
51 | if os.path.exists('MANIFEST'): os.remove('MANIFEST') | |
52 |
|
52 | |||
53 | from distutils.core import setup |
|
53 | from distutils.core import setup | |
54 |
|
54 | |||
55 | # Our own imports |
|
55 | # Our own imports | |
56 | from setupbase import target_update |
|
56 | from setupbase import target_update | |
57 |
|
57 | |||
58 | from setupbase import ( |
|
58 | from setupbase import ( | |
59 | setup_args, |
|
59 | setup_args, | |
60 | find_packages, |
|
60 | find_packages, | |
61 | find_package_data, |
|
61 | find_package_data, | |
62 | check_package_data_first, |
|
62 | check_package_data_first, | |
63 | find_entry_points, |
|
63 | find_entry_points, | |
64 | build_scripts_entrypt, |
|
64 | build_scripts_entrypt, | |
65 | find_data_files, |
|
65 | find_data_files, | |
66 | check_for_dependencies, |
|
66 | check_for_dependencies, | |
67 | git_prebuild, |
|
67 | git_prebuild, | |
68 | check_submodule_status, |
|
68 | check_submodule_status, | |
69 | update_submodules, |
|
69 | update_submodules, | |
70 | require_submodules, |
|
70 | require_submodules, | |
71 | UpdateSubmodules, |
|
71 | UpdateSubmodules, | |
72 | get_bdist_wheel, |
|
72 | get_bdist_wheel, | |
73 | CompileCSS, |
|
73 | CompileCSS, | |
74 | JavascriptVersion, |
|
74 | JavascriptVersion, | |
75 | css_js_prerelease, |
|
75 | css_js_prerelease, | |
76 | install_symlinked, |
|
76 | install_symlinked, | |
77 | install_lib_symlink, |
|
77 | install_lib_symlink, | |
78 | install_scripts_for_symlink, |
|
78 | install_scripts_for_symlink, | |
79 | unsymlink, |
|
79 | unsymlink, | |
80 | ) |
|
80 | ) | |
81 | from setupext import setupext |
|
81 | from setupext import setupext | |
82 |
|
82 | |||
83 | isfile = os.path.isfile |
|
83 | isfile = os.path.isfile | |
84 | pjoin = os.path.join |
|
84 | pjoin = os.path.join | |
85 |
|
85 | |||
86 | #----------------------------------------------------------------------------- |
|
86 | #----------------------------------------------------------------------------- | |
87 | # Function definitions |
|
87 | # Function definitions | |
88 | #----------------------------------------------------------------------------- |
|
88 | #----------------------------------------------------------------------------- | |
89 |
|
89 | |||
90 | def cleanup(): |
|
90 | def cleanup(): | |
91 | """Clean up the junk left around by the build process""" |
|
91 | """Clean up the junk left around by the build process""" | |
92 | if "develop" not in sys.argv and "egg_info" not in sys.argv: |
|
92 | if "develop" not in sys.argv and "egg_info" not in sys.argv: | |
93 | try: |
|
93 | try: | |
94 | shutil.rmtree('ipython.egg-info') |
|
94 | shutil.rmtree('ipython.egg-info') | |
95 | except: |
|
95 | except: | |
96 | try: |
|
96 | try: | |
97 | os.unlink('ipython.egg-info') |
|
97 | os.unlink('ipython.egg-info') | |
98 | except: |
|
98 | except: | |
99 | pass |
|
99 | pass | |
100 |
|
100 | |||
101 | #------------------------------------------------------------------------------- |
|
101 | #------------------------------------------------------------------------------- | |
102 | # Handle OS specific things |
|
102 | # Handle OS specific things | |
103 | #------------------------------------------------------------------------------- |
|
103 | #------------------------------------------------------------------------------- | |
104 |
|
104 | |||
105 | if os.name in ('nt','dos'): |
|
105 | if os.name in ('nt','dos'): | |
106 | os_name = 'windows' |
|
106 | os_name = 'windows' | |
107 | else: |
|
107 | else: | |
108 | os_name = os.name |
|
108 | os_name = os.name | |
109 |
|
109 | |||
110 | # Under Windows, 'sdist' has not been supported. Now that the docs build with |
|
110 | # Under Windows, 'sdist' has not been supported. Now that the docs build with | |
111 | # Sphinx it might work, but let's not turn it on until someone confirms that it |
|
111 | # Sphinx it might work, but let's not turn it on until someone confirms that it | |
112 | # actually works. |
|
112 | # actually works. | |
113 | if os_name == 'windows' and 'sdist' in sys.argv: |
|
113 | if os_name == 'windows' and 'sdist' in sys.argv: | |
114 | print('The sdist command is not available under Windows. Exiting.') |
|
114 | print('The sdist command is not available under Windows. Exiting.') | |
115 | sys.exit(1) |
|
115 | sys.exit(1) | |
116 |
|
116 | |||
117 | #------------------------------------------------------------------------------- |
|
117 | #------------------------------------------------------------------------------- | |
118 | # Make sure we aren't trying to run without submodules |
|
118 | # Make sure we aren't trying to run without submodules | |
119 | #------------------------------------------------------------------------------- |
|
119 | #------------------------------------------------------------------------------- | |
120 | here = os.path.abspath(os.path.dirname(__file__)) |
|
120 | here = os.path.abspath(os.path.dirname(__file__)) | |
121 |
|
121 | |||
122 | def require_clean_submodules(): |
|
122 | def require_clean_submodules(): | |
123 | """Check on git submodules before distutils can do anything |
|
123 | """Check on git submodules before distutils can do anything | |
124 |
|
124 | |||
125 | Since distutils cannot be trusted to update the tree |
|
125 | Since distutils cannot be trusted to update the tree | |
126 | after everything has been set in motion, |
|
126 | after everything has been set in motion, | |
127 | this is not a distutils command. |
|
127 | this is not a distutils command. | |
128 | """ |
|
128 | """ | |
129 | # PACKAGERS: Add a return here to skip checks for git submodules |
|
129 | # PACKAGERS: Add a return here to skip checks for git submodules | |
130 |
|
130 | |||
131 | # don't do anything if nothing is actually supposed to happen |
|
131 | # don't do anything if nothing is actually supposed to happen | |
132 | for do_nothing in ('-h', '--help', '--help-commands', 'clean', 'submodule'): |
|
132 | for do_nothing in ('-h', '--help', '--help-commands', 'clean', 'submodule'): | |
133 | if do_nothing in sys.argv: |
|
133 | if do_nothing in sys.argv: | |
134 | return |
|
134 | return | |
135 |
|
135 | |||
136 | status = check_submodule_status(here) |
|
136 | status = check_submodule_status(here) | |
137 |
|
137 | |||
138 | if status == "missing": |
|
138 | if status == "missing": | |
139 | print("checking out submodules for the first time") |
|
139 | print("checking out submodules for the first time") | |
140 | update_submodules(here) |
|
140 | update_submodules(here) | |
141 | elif status == "unclean": |
|
141 | elif status == "unclean": | |
142 | print('\n'.join([ |
|
142 | print('\n'.join([ | |
143 | "Cannot build / install IPython with unclean submodules", |
|
143 | "Cannot build / install IPython with unclean submodules", | |
144 | "Please update submodules with", |
|
144 | "Please update submodules with", | |
145 | " python setup.py submodule", |
|
145 | " python setup.py submodule", | |
146 | "or", |
|
146 | "or", | |
147 | " git submodule update", |
|
147 | " git submodule update", | |
148 | "or commit any submodule changes you have made." |
|
148 | "or commit any submodule changes you have made." | |
149 | ])) |
|
149 | ])) | |
150 | sys.exit(1) |
|
150 | sys.exit(1) | |
151 |
|
151 | |||
152 | require_clean_submodules() |
|
152 | require_clean_submodules() | |
153 |
|
153 | |||
154 | #------------------------------------------------------------------------------- |
|
154 | #------------------------------------------------------------------------------- | |
155 | # Things related to the IPython documentation |
|
155 | # Things related to the IPython documentation | |
156 | #------------------------------------------------------------------------------- |
|
156 | #------------------------------------------------------------------------------- | |
157 |
|
157 | |||
158 | # update the manuals when building a source dist |
|
158 | # update the manuals when building a source dist | |
159 | if len(sys.argv) >= 2 and sys.argv[1] in ('sdist','bdist_rpm'): |
|
159 | if len(sys.argv) >= 2 and sys.argv[1] in ('sdist','bdist_rpm'): | |
160 |
|
160 | |||
161 | # List of things to be updated. Each entry is a triplet of args for |
|
161 | # List of things to be updated. Each entry is a triplet of args for | |
162 | # target_update() |
|
162 | # target_update() | |
163 | to_update = [ |
|
163 | to_update = [ | |
164 | # FIXME - Disabled for now: we need to redo an automatic way |
|
164 | # FIXME - Disabled for now: we need to redo an automatic way | |
165 | # of generating the magic info inside the rst. |
|
165 | # of generating the magic info inside the rst. | |
166 | #('docs/magic.tex', |
|
166 | #('docs/magic.tex', | |
167 | #['IPython/Magic.py'], |
|
167 | #['IPython/Magic.py'], | |
168 | #"cd doc && ./update_magic.sh" ), |
|
168 | #"cd doc && ./update_magic.sh" ), | |
169 |
|
169 | |||
170 | ('docs/man/ipcluster.1.gz', |
|
170 | ('docs/man/ipcluster.1.gz', | |
171 | ['docs/man/ipcluster.1'], |
|
171 | ['docs/man/ipcluster.1'], | |
172 | 'cd docs/man && gzip -9c ipcluster.1 > ipcluster.1.gz'), |
|
172 | 'cd docs/man && gzip -9c ipcluster.1 > ipcluster.1.gz'), | |
173 |
|
173 | |||
174 | ('docs/man/ipcontroller.1.gz', |
|
174 | ('docs/man/ipcontroller.1.gz', | |
175 | ['docs/man/ipcontroller.1'], |
|
175 | ['docs/man/ipcontroller.1'], | |
176 | 'cd docs/man && gzip -9c ipcontroller.1 > ipcontroller.1.gz'), |
|
176 | 'cd docs/man && gzip -9c ipcontroller.1 > ipcontroller.1.gz'), | |
177 |
|
177 | |||
178 | ('docs/man/ipengine.1.gz', |
|
178 | ('docs/man/ipengine.1.gz', | |
179 | ['docs/man/ipengine.1'], |
|
179 | ['docs/man/ipengine.1'], | |
180 | 'cd docs/man && gzip -9c ipengine.1 > ipengine.1.gz'), |
|
180 | 'cd docs/man && gzip -9c ipengine.1 > ipengine.1.gz'), | |
181 |
|
181 | |||
182 | ('docs/man/ipython.1.gz', |
|
182 | ('docs/man/ipython.1.gz', | |
183 | ['docs/man/ipython.1'], |
|
183 | ['docs/man/ipython.1'], | |
184 | 'cd docs/man && gzip -9c ipython.1 > ipython.1.gz'), |
|
184 | 'cd docs/man && gzip -9c ipython.1 > ipython.1.gz'), | |
185 |
|
185 | |||
186 | ] |
|
186 | ] | |
187 |
|
187 | |||
188 |
|
188 | |||
189 | [ target_update(*t) for t in to_update ] |
|
189 | [ target_update(*t) for t in to_update ] | |
190 |
|
190 | |||
191 | #--------------------------------------------------------------------------- |
|
191 | #--------------------------------------------------------------------------- | |
192 | # Find all the packages, package data, and data_files |
|
192 | # Find all the packages, package data, and data_files | |
193 | #--------------------------------------------------------------------------- |
|
193 | #--------------------------------------------------------------------------- | |
194 |
|
194 | |||
195 | packages = find_packages() |
|
195 | packages = find_packages() | |
196 | package_data = find_package_data() |
|
196 | package_data = find_package_data() | |
197 |
|
197 | |||
198 | data_files = find_data_files() |
|
198 | data_files = find_data_files() | |
199 |
|
199 | |||
200 | setup_args['packages'] = packages |
|
200 | setup_args['packages'] = packages | |
201 | setup_args['package_data'] = package_data |
|
201 | setup_args['package_data'] = package_data | |
202 | setup_args['data_files'] = data_files |
|
202 | setup_args['data_files'] = data_files | |
203 |
|
203 | |||
204 | #--------------------------------------------------------------------------- |
|
204 | #--------------------------------------------------------------------------- | |
205 | # custom distutils commands |
|
205 | # custom distutils commands | |
206 | #--------------------------------------------------------------------------- |
|
206 | #--------------------------------------------------------------------------- | |
207 | # imports here, so they are after setuptools import if there was one |
|
207 | # imports here, so they are after setuptools import if there was one | |
208 | from distutils.command.sdist import sdist |
|
208 | from distutils.command.sdist import sdist | |
209 | from distutils.command.upload import upload |
|
209 | from distutils.command.upload import upload | |
210 |
|
210 | |||
211 | class UploadWindowsInstallers(upload): |
|
211 | class UploadWindowsInstallers(upload): | |
212 |
|
212 | |||
213 | description = "Upload Windows installers to PyPI (only used from tools/release_windows.py)" |
|
213 | description = "Upload Windows installers to PyPI (only used from tools/release_windows.py)" | |
214 | user_options = upload.user_options + [ |
|
214 | user_options = upload.user_options + [ | |
215 | ('files=', 'f', 'exe file (or glob) to upload') |
|
215 | ('files=', 'f', 'exe file (or glob) to upload') | |
216 | ] |
|
216 | ] | |
217 | def initialize_options(self): |
|
217 | def initialize_options(self): | |
218 | upload.initialize_options(self) |
|
218 | upload.initialize_options(self) | |
219 | meta = self.distribution.metadata |
|
219 | meta = self.distribution.metadata | |
220 | base = '{name}-{version}'.format( |
|
220 | base = '{name}-{version}'.format( | |
221 | name=meta.get_name(), |
|
221 | name=meta.get_name(), | |
222 | version=meta.get_version() |
|
222 | version=meta.get_version() | |
223 | ) |
|
223 | ) | |
224 | self.files = os.path.join('dist', '%s.*.exe' % base) |
|
224 | self.files = os.path.join('dist', '%s.*.exe' % base) | |
225 |
|
225 | |||
226 | def run(self): |
|
226 | def run(self): | |
227 | for dist_file in glob(self.files): |
|
227 | for dist_file in glob(self.files): | |
228 | self.upload_file('bdist_wininst', 'any', dist_file) |
|
228 | self.upload_file('bdist_wininst', 'any', dist_file) | |
229 |
|
229 | |||
230 | setup_args['cmdclass'] = { |
|
230 | setup_args['cmdclass'] = { | |
231 | 'build_py': css_js_prerelease( |
|
231 | 'build_py': css_js_prerelease( | |
232 | check_package_data_first(git_prebuild('IPython')), |
|
232 | check_package_data_first(git_prebuild('IPython')), | |
233 | strict=False), |
|
233 | strict=False), | |
234 | 'sdist' : css_js_prerelease(git_prebuild('IPython', sdist)), |
|
234 | 'sdist' : css_js_prerelease(git_prebuild('IPython', sdist)), | |
235 | 'upload_wininst' : UploadWindowsInstallers, |
|
235 | 'upload_wininst' : UploadWindowsInstallers, | |
236 | 'submodule' : UpdateSubmodules, |
|
236 | 'submodule' : UpdateSubmodules, | |
237 | 'css' : CompileCSS, |
|
237 | 'css' : CompileCSS, | |
238 | 'symlink': install_symlinked, |
|
238 | 'symlink': install_symlinked, | |
239 | 'install_lib_symlink': install_lib_symlink, |
|
239 | 'install_lib_symlink': install_lib_symlink, | |
240 | 'install_scripts_sym': install_scripts_for_symlink, |
|
240 | 'install_scripts_sym': install_scripts_for_symlink, | |
241 | 'unsymlink': unsymlink, |
|
241 | 'unsymlink': unsymlink, | |
242 | 'jsversion' : JavascriptVersion, |
|
242 | 'jsversion' : JavascriptVersion, | |
243 | } |
|
243 | } | |
244 |
|
244 | |||
245 | #--------------------------------------------------------------------------- |
|
245 | #--------------------------------------------------------------------------- | |
246 | # Handle scripts, dependencies, and setuptools specific things |
|
246 | # Handle scripts, dependencies, and setuptools specific things | |
247 | #--------------------------------------------------------------------------- |
|
247 | #--------------------------------------------------------------------------- | |
248 |
|
248 | |||
249 | # For some commands, use setuptools. Note that we do NOT list install here! |
|
249 | # For some commands, use setuptools. Note that we do NOT list install here! | |
250 | # If you want a setuptools-enhanced install, just run 'setupegg.py install' |
|
250 | # If you want a setuptools-enhanced install, just run 'setupegg.py install' | |
251 | needs_setuptools = set(('develop', 'release', 'bdist_egg', 'bdist_rpm', |
|
251 | needs_setuptools = set(('develop', 'release', 'bdist_egg', 'bdist_rpm', | |
252 | 'bdist', 'bdist_dumb', 'bdist_wininst', 'bdist_wheel', |
|
252 | 'bdist', 'bdist_dumb', 'bdist_wininst', 'bdist_wheel', | |
253 | 'egg_info', 'easy_install', 'upload', 'install_egg_info', |
|
253 | 'egg_info', 'easy_install', 'upload', 'install_egg_info', | |
254 | )) |
|
254 | )) | |
255 | if sys.platform == 'win32': |
|
|||
256 | # Depend on setuptools for install on *Windows only* |
|
|||
257 | # If we get script-installation working without setuptools, |
|
|||
258 | # then we can back off, but until then use it. |
|
|||
259 | # See Issue #369 on GitHub for more |
|
|||
260 | needs_setuptools.add('install') |
|
|||
261 |
|
255 | |||
262 | if len(needs_setuptools.intersection(sys.argv)) > 0: |
|
256 | if len(needs_setuptools.intersection(sys.argv)) > 0: | |
263 | import setuptools |
|
257 | import setuptools | |
264 |
|
258 | |||
265 | # This dict is used for passing extra arguments that are setuptools |
|
259 | # This dict is used for passing extra arguments that are setuptools | |
266 | # specific to setup |
|
260 | # specific to setup | |
267 | setuptools_extra_args = {} |
|
261 | setuptools_extra_args = {} | |
268 |
|
262 | |||
269 | # setuptools requirements |
|
263 | # setuptools requirements | |
270 |
|
264 | |||
271 | extras_require = dict( |
|
265 | extras_require = dict( | |
272 | parallel = ['pyzmq>=2.1.11'], |
|
266 | parallel = ['pyzmq>=2.1.11'], | |
273 | qtconsole = ['pyzmq>=2.1.11', 'pygments'], |
|
267 | qtconsole = ['pyzmq>=2.1.11', 'pygments'], | |
274 | zmq = ['pyzmq>=2.1.11'], |
|
268 | zmq = ['pyzmq>=2.1.11'], | |
275 | doc = ['Sphinx>=1.1', 'numpydoc'], |
|
269 | doc = ['Sphinx>=1.1', 'numpydoc'], | |
276 | test = ['nose>=0.10.1', 'requests'], |
|
270 | test = ['nose>=0.10.1', 'requests'], | |
277 | terminal = [], |
|
271 | terminal = [], | |
278 | nbformat = ['jsonschema>=2.0'], |
|
272 | nbformat = ['jsonschema>=2.0'], | |
279 | notebook = ['tornado>=3.1', 'pyzmq>=2.1.11', 'jinja2', 'pygments', 'mistune>=0.3.1'], |
|
273 | notebook = ['tornado>=3.1', 'pyzmq>=2.1.11', 'jinja2', 'pygments', 'mistune>=0.3.1'], | |
280 | nbconvert = ['pygments', 'jinja2', 'mistune>=0.3.1'] |
|
274 | nbconvert = ['pygments', 'jinja2', 'mistune>=0.3.1'] | |
281 | ) |
|
275 | ) | |
282 |
|
276 | |||
283 | if sys.version_info < (3, 3): |
|
277 | if sys.version_info < (3, 3): | |
284 | extras_require['test'].append('mock') |
|
278 | extras_require['test'].append('mock') | |
285 |
|
279 | |||
286 | extras_require['notebook'].extend(extras_require['nbformat']) |
|
280 | extras_require['notebook'].extend(extras_require['nbformat']) | |
287 | extras_require['nbconvert'].extend(extras_require['nbformat']) |
|
281 | extras_require['nbconvert'].extend(extras_require['nbformat']) | |
288 |
|
282 | |||
289 | everything = set() |
|
283 | everything = set() | |
290 | for deps in extras_require.values(): |
|
284 | for deps in extras_require.values(): | |
291 | everything.update(deps) |
|
285 | everything.update(deps) | |
292 | extras_require['all'] = everything |
|
286 | extras_require['all'] = everything | |
293 |
|
287 | |||
294 | install_requires = [] |
|
288 | install_requires = [] | |
295 |
|
289 | |||
296 | # add readline |
|
290 | # add readline | |
297 | if sys.platform == 'darwin': |
|
291 | if sys.platform == 'darwin': | |
298 | if any(arg.startswith('bdist') for arg in sys.argv) or not setupext.check_for_readline(): |
|
292 | if any(arg.startswith('bdist') for arg in sys.argv) or not setupext.check_for_readline(): | |
299 | install_requires.append('gnureadline') |
|
293 | install_requires.append('gnureadline') | |
300 | elif sys.platform.startswith('win'): |
|
294 | elif sys.platform.startswith('win'): | |
301 | extras_require['terminal'].append('pyreadline>=2.0') |
|
295 | extras_require['terminal'].append('pyreadline>=2.0') | |
302 |
|
296 | |||
303 |
|
297 | |||
304 | if 'setuptools' in sys.modules: |
|
298 | if 'setuptools' in sys.modules: | |
305 | # setup.py develop should check for submodules |
|
299 | # setup.py develop should check for submodules | |
306 | from setuptools.command.develop import develop |
|
300 | from setuptools.command.develop import develop | |
307 | setup_args['cmdclass']['develop'] = require_submodules(develop) |
|
301 | setup_args['cmdclass']['develop'] = require_submodules(develop) | |
308 | setup_args['cmdclass']['bdist_wheel'] = css_js_prerelease(get_bdist_wheel()) |
|
302 | setup_args['cmdclass']['bdist_wheel'] = css_js_prerelease(get_bdist_wheel()) | |
309 |
|
303 | |||
310 | setuptools_extra_args['zip_safe'] = False |
|
304 | setuptools_extra_args['zip_safe'] = False | |
311 | setuptools_extra_args['entry_points'] = {'console_scripts':find_entry_points()} |
|
305 | setuptools_extra_args['entry_points'] = {'console_scripts':find_entry_points()} | |
312 | setup_args['extras_require'] = extras_require |
|
306 | setup_args['extras_require'] = extras_require | |
313 | requires = setup_args['install_requires'] = install_requires |
|
307 | requires = setup_args['install_requires'] = install_requires | |
314 |
|
308 | |||
315 | # Script to be run by the windows binary installer after the default setup |
|
309 | # Script to be run by the windows binary installer after the default setup | |
316 | # routine, to add shortcuts and similar windows-only things. Windows |
|
310 | # routine, to add shortcuts and similar windows-only things. Windows | |
317 | # post-install scripts MUST reside in the scripts/ dir, otherwise distutils |
|
311 | # post-install scripts MUST reside in the scripts/ dir, otherwise distutils | |
318 | # doesn't find them. |
|
312 | # doesn't find them. | |
319 | if 'bdist_wininst' in sys.argv: |
|
313 | if 'bdist_wininst' in sys.argv: | |
320 | if len(sys.argv) > 2 and \ |
|
314 | if len(sys.argv) > 2 and \ | |
321 | ('sdist' in sys.argv or 'bdist_rpm' in sys.argv): |
|
315 | ('sdist' in sys.argv or 'bdist_rpm' in sys.argv): | |
322 | print >> sys.stderr, "ERROR: bdist_wininst must be run alone. Exiting." |
|
316 | print >> sys.stderr, "ERROR: bdist_wininst must be run alone. Exiting." | |
323 | sys.exit(1) |
|
317 | sys.exit(1) | |
324 | setup_args['data_files'].append( |
|
318 | setup_args['data_files'].append( | |
325 | ['Scripts', ('scripts/ipython.ico', 'scripts/ipython_nb.ico')]) |
|
319 | ['Scripts', ('scripts/ipython.ico', 'scripts/ipython_nb.ico')]) | |
326 | setup_args['scripts'] = [pjoin('scripts','ipython_win_post_install.py')] |
|
320 | setup_args['scripts'] = [pjoin('scripts','ipython_win_post_install.py')] | |
327 | setup_args['options'] = {"bdist_wininst": |
|
321 | setup_args['options'] = {"bdist_wininst": | |
328 | {"install_script": |
|
322 | {"install_script": | |
329 | "ipython_win_post_install.py"}} |
|
323 | "ipython_win_post_install.py"}} | |
330 |
|
324 | |||
331 | else: |
|
325 | else: | |
332 | # If we are installing without setuptools, call this function which will |
|
326 | # If we are installing without setuptools, call this function which will | |
333 | # check for dependencies an inform the user what is needed. This is |
|
327 | # check for dependencies an inform the user what is needed. This is | |
334 | # just to make life easy for users. |
|
328 | # just to make life easy for users. | |
335 | for install_cmd in ('install', 'symlink'): |
|
329 | for install_cmd in ('install', 'symlink'): | |
336 | if install_cmd in sys.argv: |
|
330 | if install_cmd in sys.argv: | |
337 | check_for_dependencies() |
|
331 | check_for_dependencies() | |
338 | break |
|
332 | break | |
339 | # scripts has to be a non-empty list, or install_scripts isn't called |
|
333 | # scripts has to be a non-empty list, or install_scripts isn't called | |
340 | setup_args['scripts'] = [e.split('=')[0].strip() for e in find_entry_points()] |
|
334 | setup_args['scripts'] = [e.split('=')[0].strip() for e in find_entry_points()] | |
341 |
|
335 | |||
342 | setup_args['cmdclass']['build_scripts'] = build_scripts_entrypt |
|
336 | setup_args['cmdclass']['build_scripts'] = build_scripts_entrypt | |
343 |
|
337 | |||
344 | #--------------------------------------------------------------------------- |
|
338 | #--------------------------------------------------------------------------- | |
345 | # Do the actual setup now |
|
339 | # Do the actual setup now | |
346 | #--------------------------------------------------------------------------- |
|
340 | #--------------------------------------------------------------------------- | |
347 |
|
341 | |||
348 | setup_args.update(setuptools_extra_args) |
|
342 | setup_args.update(setuptools_extra_args) | |
349 |
|
343 | |||
350 | def main(): |
|
344 | def main(): | |
351 | setup(**setup_args) |
|
345 | setup(**setup_args) | |
352 | cleanup() |
|
346 | cleanup() | |
353 |
|
347 | |||
354 | if __name__ == '__main__': |
|
348 | if __name__ == '__main__': | |
355 | main() |
|
349 | main() |
@@ -1,737 +1,754 b'' | |||||
1 | # encoding: utf-8 |
|
1 | # encoding: utf-8 | |
2 | """ |
|
2 | """ | |
3 | This module defines the things that are used in setup.py for building IPython |
|
3 | This module defines the things that are used in setup.py for building IPython | |
4 |
|
4 | |||
5 | This includes: |
|
5 | This includes: | |
6 |
|
6 | |||
7 | * The basic arguments to setup |
|
7 | * The basic arguments to setup | |
8 | * Functions for finding things like packages, package data, etc. |
|
8 | * Functions for finding things like packages, package data, etc. | |
9 | * A function for checking dependencies. |
|
9 | * A function for checking dependencies. | |
10 | """ |
|
10 | """ | |
11 |
|
11 | |||
12 | # Copyright (c) IPython Development Team. |
|
12 | # Copyright (c) IPython Development Team. | |
13 | # Distributed under the terms of the Modified BSD License. |
|
13 | # Distributed under the terms of the Modified BSD License. | |
14 |
|
14 | |||
15 | from __future__ import print_function |
|
15 | from __future__ import print_function | |
16 |
|
16 | |||
17 | import errno |
|
17 | import errno | |
18 | import os |
|
18 | import os | |
19 | import sys |
|
19 | import sys | |
20 |
|
20 | |||
21 | from distutils import log |
|
21 | from distutils import log | |
22 | from distutils.command.build_py import build_py |
|
22 | from distutils.command.build_py import build_py | |
23 | from distutils.command.build_scripts import build_scripts |
|
23 | from distutils.command.build_scripts import build_scripts | |
24 | from distutils.command.install import install |
|
24 | from distutils.command.install import install | |
25 | from distutils.command.install_scripts import install_scripts |
|
25 | from distutils.command.install_scripts import install_scripts | |
26 | from distutils.cmd import Command |
|
26 | from distutils.cmd import Command | |
27 | from fnmatch import fnmatch |
|
27 | from fnmatch import fnmatch | |
28 | from glob import glob |
|
28 | from glob import glob | |
29 | from subprocess import check_call |
|
29 | from subprocess import check_call | |
30 |
|
30 | |||
31 | from setupext import install_data_ext |
|
31 | from setupext import install_data_ext | |
32 |
|
32 | |||
33 | #------------------------------------------------------------------------------- |
|
33 | #------------------------------------------------------------------------------- | |
34 | # Useful globals and utility functions |
|
34 | # Useful globals and utility functions | |
35 | #------------------------------------------------------------------------------- |
|
35 | #------------------------------------------------------------------------------- | |
36 |
|
36 | |||
37 | # A few handy globals |
|
37 | # A few handy globals | |
38 | isfile = os.path.isfile |
|
38 | isfile = os.path.isfile | |
39 | pjoin = os.path.join |
|
39 | pjoin = os.path.join | |
40 | repo_root = os.path.dirname(os.path.abspath(__file__)) |
|
40 | repo_root = os.path.dirname(os.path.abspath(__file__)) | |
41 |
|
41 | |||
42 | def oscmd(s): |
|
42 | def oscmd(s): | |
43 | print(">", s) |
|
43 | print(">", s) | |
44 | os.system(s) |
|
44 | os.system(s) | |
45 |
|
45 | |||
46 | # Py3 compatibility hacks, without assuming IPython itself is installed with |
|
46 | # Py3 compatibility hacks, without assuming IPython itself is installed with | |
47 | # the full py3compat machinery. |
|
47 | # the full py3compat machinery. | |
48 |
|
48 | |||
49 | try: |
|
49 | try: | |
50 | execfile |
|
50 | execfile | |
51 | except NameError: |
|
51 | except NameError: | |
52 | def execfile(fname, globs, locs=None): |
|
52 | def execfile(fname, globs, locs=None): | |
53 | locs = locs or globs |
|
53 | locs = locs or globs | |
54 | exec(compile(open(fname).read(), fname, "exec"), globs, locs) |
|
54 | exec(compile(open(fname).read(), fname, "exec"), globs, locs) | |
55 |
|
55 | |||
56 | # A little utility we'll need below, since glob() does NOT allow you to do |
|
56 | # A little utility we'll need below, since glob() does NOT allow you to do | |
57 | # exclusion on multiple endings! |
|
57 | # exclusion on multiple endings! | |
58 | def file_doesnt_endwith(test,endings): |
|
58 | def file_doesnt_endwith(test,endings): | |
59 | """Return true if test is a file and its name does NOT end with any |
|
59 | """Return true if test is a file and its name does NOT end with any | |
60 | of the strings listed in endings.""" |
|
60 | of the strings listed in endings.""" | |
61 | if not isfile(test): |
|
61 | if not isfile(test): | |
62 | return False |
|
62 | return False | |
63 | for e in endings: |
|
63 | for e in endings: | |
64 | if test.endswith(e): |
|
64 | if test.endswith(e): | |
65 | return False |
|
65 | return False | |
66 | return True |
|
66 | return True | |
67 |
|
67 | |||
68 | #--------------------------------------------------------------------------- |
|
68 | #--------------------------------------------------------------------------- | |
69 | # Basic project information |
|
69 | # Basic project information | |
70 | #--------------------------------------------------------------------------- |
|
70 | #--------------------------------------------------------------------------- | |
71 |
|
71 | |||
72 | # release.py contains version, authors, license, url, keywords, etc. |
|
72 | # release.py contains version, authors, license, url, keywords, etc. | |
73 | execfile(pjoin(repo_root, 'IPython','core','release.py'), globals()) |
|
73 | execfile(pjoin(repo_root, 'IPython','core','release.py'), globals()) | |
74 |
|
74 | |||
75 | # Create a dict with the basic information |
|
75 | # Create a dict with the basic information | |
76 | # This dict is eventually passed to setup after additional keys are added. |
|
76 | # This dict is eventually passed to setup after additional keys are added. | |
77 | setup_args = dict( |
|
77 | setup_args = dict( | |
78 | name = name, |
|
78 | name = name, | |
79 | version = version, |
|
79 | version = version, | |
80 | description = description, |
|
80 | description = description, | |
81 | long_description = long_description, |
|
81 | long_description = long_description, | |
82 | author = author, |
|
82 | author = author, | |
83 | author_email = author_email, |
|
83 | author_email = author_email, | |
84 | url = url, |
|
84 | url = url, | |
85 | download_url = download_url, |
|
85 | download_url = download_url, | |
86 | license = license, |
|
86 | license = license, | |
87 | platforms = platforms, |
|
87 | platforms = platforms, | |
88 | keywords = keywords, |
|
88 | keywords = keywords, | |
89 | classifiers = classifiers, |
|
89 | classifiers = classifiers, | |
90 | cmdclass = {'install_data': install_data_ext}, |
|
90 | cmdclass = {'install_data': install_data_ext}, | |
91 | ) |
|
91 | ) | |
92 |
|
92 | |||
93 |
|
93 | |||
94 | #--------------------------------------------------------------------------- |
|
94 | #--------------------------------------------------------------------------- | |
95 | # Find packages |
|
95 | # Find packages | |
96 | #--------------------------------------------------------------------------- |
|
96 | #--------------------------------------------------------------------------- | |
97 |
|
97 | |||
98 | def find_packages(): |
|
98 | def find_packages(): | |
99 | """ |
|
99 | """ | |
100 | Find all of IPython's packages. |
|
100 | Find all of IPython's packages. | |
101 | """ |
|
101 | """ | |
102 | excludes = ['deathrow', 'quarantine'] |
|
102 | excludes = ['deathrow', 'quarantine'] | |
103 | packages = [] |
|
103 | packages = [] | |
104 | for dir,subdirs,files in os.walk('IPython'): |
|
104 | for dir,subdirs,files in os.walk('IPython'): | |
105 | package = dir.replace(os.path.sep, '.') |
|
105 | package = dir.replace(os.path.sep, '.') | |
106 | if any(package.startswith('IPython.'+exc) for exc in excludes): |
|
106 | if any(package.startswith('IPython.'+exc) for exc in excludes): | |
107 | # package is to be excluded (e.g. deathrow) |
|
107 | # package is to be excluded (e.g. deathrow) | |
108 | continue |
|
108 | continue | |
109 | if '__init__.py' not in files: |
|
109 | if '__init__.py' not in files: | |
110 | # not a package |
|
110 | # not a package | |
111 | continue |
|
111 | continue | |
112 | packages.append(package) |
|
112 | packages.append(package) | |
113 | return packages |
|
113 | return packages | |
114 |
|
114 | |||
115 | #--------------------------------------------------------------------------- |
|
115 | #--------------------------------------------------------------------------- | |
116 | # Find package data |
|
116 | # Find package data | |
117 | #--------------------------------------------------------------------------- |
|
117 | #--------------------------------------------------------------------------- | |
118 |
|
118 | |||
119 | def find_package_data(): |
|
119 | def find_package_data(): | |
120 | """ |
|
120 | """ | |
121 | Find IPython's package_data. |
|
121 | Find IPython's package_data. | |
122 | """ |
|
122 | """ | |
123 | # This is not enough for these things to appear in an sdist. |
|
123 | # This is not enough for these things to appear in an sdist. | |
124 | # We need to muck with the MANIFEST to get this to work |
|
124 | # We need to muck with the MANIFEST to get this to work | |
125 |
|
125 | |||
126 | # exclude components and less from the walk; |
|
126 | # exclude components and less from the walk; | |
127 | # we will build the components separately |
|
127 | # we will build the components separately | |
128 | excludes = [ |
|
128 | excludes = [ | |
129 | pjoin('static', 'components'), |
|
129 | pjoin('static', 'components'), | |
130 | pjoin('static', '*', 'less'), |
|
130 | pjoin('static', '*', 'less'), | |
131 | ] |
|
131 | ] | |
132 |
|
132 | |||
133 | # walk notebook resources: |
|
133 | # walk notebook resources: | |
134 | cwd = os.getcwd() |
|
134 | cwd = os.getcwd() | |
135 | os.chdir(os.path.join('IPython', 'html')) |
|
135 | os.chdir(os.path.join('IPython', 'html')) | |
136 | static_data = [] |
|
136 | static_data = [] | |
137 | for parent, dirs, files in os.walk('static'): |
|
137 | for parent, dirs, files in os.walk('static'): | |
138 | if any(fnmatch(parent, pat) for pat in excludes): |
|
138 | if any(fnmatch(parent, pat) for pat in excludes): | |
139 | # prevent descending into subdirs |
|
139 | # prevent descending into subdirs | |
140 | dirs[:] = [] |
|
140 | dirs[:] = [] | |
141 | continue |
|
141 | continue | |
142 | for f in files: |
|
142 | for f in files: | |
143 | static_data.append(pjoin(parent, f)) |
|
143 | static_data.append(pjoin(parent, f)) | |
144 |
|
144 | |||
145 | components = pjoin("static", "components") |
|
145 | components = pjoin("static", "components") | |
146 | # select the components we actually need to install |
|
146 | # select the components we actually need to install | |
147 | # (there are lots of resources we bundle for sdist-reasons that we don't actually use) |
|
147 | # (there are lots of resources we bundle for sdist-reasons that we don't actually use) | |
148 | static_data.extend([ |
|
148 | static_data.extend([ | |
149 | pjoin(components, "backbone", "backbone-min.js"), |
|
149 | pjoin(components, "backbone", "backbone-min.js"), | |
150 | pjoin(components, "bootstrap", "js", "bootstrap.min.js"), |
|
150 | pjoin(components, "bootstrap", "js", "bootstrap.min.js"), | |
151 | pjoin(components, "bootstrap-tour", "build", "css", "bootstrap-tour.min.css"), |
|
151 | pjoin(components, "bootstrap-tour", "build", "css", "bootstrap-tour.min.css"), | |
152 | pjoin(components, "bootstrap-tour", "build", "js", "bootstrap-tour.min.js"), |
|
152 | pjoin(components, "bootstrap-tour", "build", "js", "bootstrap-tour.min.js"), | |
153 | pjoin(components, "font-awesome", "fonts", "*.*"), |
|
153 | pjoin(components, "font-awesome", "fonts", "*.*"), | |
154 | pjoin(components, "google-caja", "html-css-sanitizer-minified.js"), |
|
154 | pjoin(components, "google-caja", "html-css-sanitizer-minified.js"), | |
155 | pjoin(components, "highlight.js", "build", "highlight.pack.js"), |
|
155 | pjoin(components, "highlight.js", "build", "highlight.pack.js"), | |
156 | pjoin(components, "jquery", "jquery.min.js"), |
|
156 | pjoin(components, "jquery", "jquery.min.js"), | |
157 | pjoin(components, "jquery-ui", "ui", "minified", "jquery-ui.min.js"), |
|
157 | pjoin(components, "jquery-ui", "ui", "minified", "jquery-ui.min.js"), | |
158 | pjoin(components, "jquery-ui", "themes", "smoothness", "jquery-ui.min.css"), |
|
158 | pjoin(components, "jquery-ui", "themes", "smoothness", "jquery-ui.min.css"), | |
159 | pjoin(components, "jquery-ui", "themes", "smoothness", "images", "*"), |
|
159 | pjoin(components, "jquery-ui", "themes", "smoothness", "images", "*"), | |
160 | pjoin(components, "marked", "lib", "marked.js"), |
|
160 | pjoin(components, "marked", "lib", "marked.js"), | |
161 | pjoin(components, "requirejs", "require.js"), |
|
161 | pjoin(components, "requirejs", "require.js"), | |
162 | pjoin(components, "underscore", "underscore-min.js"), |
|
162 | pjoin(components, "underscore", "underscore-min.js"), | |
163 | pjoin(components, "moment", "moment.js"), |
|
163 | pjoin(components, "moment", "moment.js"), | |
164 | pjoin(components, "moment", "min", "moment.min.js"), |
|
164 | pjoin(components, "moment", "min", "moment.min.js"), | |
165 | pjoin(components, "term.js", "src", "term.js"), |
|
165 | pjoin(components, "term.js", "src", "term.js"), | |
166 | pjoin(components, "text-encoding", "lib", "encoding.js"), |
|
166 | pjoin(components, "text-encoding", "lib", "encoding.js"), | |
167 | ]) |
|
167 | ]) | |
168 |
|
168 | |||
169 | # Ship all of Codemirror's CSS and JS |
|
169 | # Ship all of Codemirror's CSS and JS | |
170 | for parent, dirs, files in os.walk(pjoin(components, 'codemirror')): |
|
170 | for parent, dirs, files in os.walk(pjoin(components, 'codemirror')): | |
171 | for f in files: |
|
171 | for f in files: | |
172 | if f.endswith(('.js', '.css')): |
|
172 | if f.endswith(('.js', '.css')): | |
173 | static_data.append(pjoin(parent, f)) |
|
173 | static_data.append(pjoin(parent, f)) | |
174 |
|
174 | |||
175 | os.chdir(os.path.join('tests',)) |
|
175 | os.chdir(os.path.join('tests',)) | |
176 | js_tests = glob('*.js') + glob('*/*.js') |
|
176 | js_tests = glob('*.js') + glob('*/*.js') | |
177 |
|
177 | |||
178 | os.chdir(os.path.join(cwd, 'IPython', 'nbconvert')) |
|
178 | os.chdir(os.path.join(cwd, 'IPython', 'nbconvert')) | |
179 | nbconvert_templates = [os.path.join(dirpath, '*.*') |
|
179 | nbconvert_templates = [os.path.join(dirpath, '*.*') | |
180 | for dirpath, _, _ in os.walk('templates')] |
|
180 | for dirpath, _, _ in os.walk('templates')] | |
181 |
|
181 | |||
182 | os.chdir(cwd) |
|
182 | os.chdir(cwd) | |
183 |
|
183 | |||
184 | package_data = { |
|
184 | package_data = { | |
185 | 'IPython.config.profile' : ['README*', '*/*.py'], |
|
185 | 'IPython.config.profile' : ['README*', '*/*.py'], | |
186 | 'IPython.core.tests' : ['*.png', '*.jpg'], |
|
186 | 'IPython.core.tests' : ['*.png', '*.jpg'], | |
187 | 'IPython.lib.tests' : ['*.wav'], |
|
187 | 'IPython.lib.tests' : ['*.wav'], | |
188 | 'IPython.testing.plugin' : ['*.txt'], |
|
188 | 'IPython.testing.plugin' : ['*.txt'], | |
189 | 'IPython.html' : ['templates/*'] + static_data, |
|
189 | 'IPython.html' : ['templates/*'] + static_data, | |
190 | 'IPython.html.tests' : js_tests, |
|
190 | 'IPython.html.tests' : js_tests, | |
191 | 'IPython.qt.console' : ['resources/icon/*.svg'], |
|
191 | 'IPython.qt.console' : ['resources/icon/*.svg'], | |
192 | 'IPython.nbconvert' : nbconvert_templates + |
|
192 | 'IPython.nbconvert' : nbconvert_templates + | |
193 | [ |
|
193 | [ | |
194 | 'tests/files/*.*', |
|
194 | 'tests/files/*.*', | |
195 | 'exporters/tests/files/*.*', |
|
195 | 'exporters/tests/files/*.*', | |
196 | 'preprocessors/tests/files/*.*', |
|
196 | 'preprocessors/tests/files/*.*', | |
197 | ], |
|
197 | ], | |
198 | 'IPython.nbconvert.filters' : ['marked.js'], |
|
198 | 'IPython.nbconvert.filters' : ['marked.js'], | |
199 | 'IPython.nbformat' : [ |
|
199 | 'IPython.nbformat' : [ | |
200 | 'tests/*.ipynb', |
|
200 | 'tests/*.ipynb', | |
201 | 'v3/nbformat.v3.schema.json', |
|
201 | 'v3/nbformat.v3.schema.json', | |
202 | 'v4/nbformat.v4.schema.json', |
|
202 | 'v4/nbformat.v4.schema.json', | |
203 | ] |
|
203 | ] | |
204 | } |
|
204 | } | |
205 |
|
205 | |||
206 | return package_data |
|
206 | return package_data | |
207 |
|
207 | |||
208 |
|
208 | |||
209 | def check_package_data(package_data): |
|
209 | def check_package_data(package_data): | |
210 | """verify that package_data globs make sense""" |
|
210 | """verify that package_data globs make sense""" | |
211 | print("checking package data") |
|
211 | print("checking package data") | |
212 | for pkg, data in package_data.items(): |
|
212 | for pkg, data in package_data.items(): | |
213 | pkg_root = pjoin(*pkg.split('.')) |
|
213 | pkg_root = pjoin(*pkg.split('.')) | |
214 | for d in data: |
|
214 | for d in data: | |
215 | path = pjoin(pkg_root, d) |
|
215 | path = pjoin(pkg_root, d) | |
216 | if '*' in path: |
|
216 | if '*' in path: | |
217 | assert len(glob(path)) > 0, "No files match pattern %s" % path |
|
217 | assert len(glob(path)) > 0, "No files match pattern %s" % path | |
218 | else: |
|
218 | else: | |
219 | assert os.path.exists(path), "Missing package data: %s" % path |
|
219 | assert os.path.exists(path), "Missing package data: %s" % path | |
220 |
|
220 | |||
221 |
|
221 | |||
222 | def check_package_data_first(command): |
|
222 | def check_package_data_first(command): | |
223 | """decorator for checking package_data before running a given command |
|
223 | """decorator for checking package_data before running a given command | |
224 |
|
224 | |||
225 | Probably only needs to wrap build_py |
|
225 | Probably only needs to wrap build_py | |
226 | """ |
|
226 | """ | |
227 | class DecoratedCommand(command): |
|
227 | class DecoratedCommand(command): | |
228 | def run(self): |
|
228 | def run(self): | |
229 | check_package_data(self.package_data) |
|
229 | check_package_data(self.package_data) | |
230 | command.run(self) |
|
230 | command.run(self) | |
231 | return DecoratedCommand |
|
231 | return DecoratedCommand | |
232 |
|
232 | |||
233 |
|
233 | |||
234 | #--------------------------------------------------------------------------- |
|
234 | #--------------------------------------------------------------------------- | |
235 | # Find data files |
|
235 | # Find data files | |
236 | #--------------------------------------------------------------------------- |
|
236 | #--------------------------------------------------------------------------- | |
237 |
|
237 | |||
238 | def make_dir_struct(tag,base,out_base): |
|
238 | def make_dir_struct(tag,base,out_base): | |
239 | """Make the directory structure of all files below a starting dir. |
|
239 | """Make the directory structure of all files below a starting dir. | |
240 |
|
240 | |||
241 | This is just a convenience routine to help build a nested directory |
|
241 | This is just a convenience routine to help build a nested directory | |
242 | hierarchy because distutils is too stupid to do this by itself. |
|
242 | hierarchy because distutils is too stupid to do this by itself. | |
243 |
|
243 | |||
244 | XXX - this needs a proper docstring! |
|
244 | XXX - this needs a proper docstring! | |
245 | """ |
|
245 | """ | |
246 |
|
246 | |||
247 | # we'll use these a lot below |
|
247 | # we'll use these a lot below | |
248 | lbase = len(base) |
|
248 | lbase = len(base) | |
249 | pathsep = os.path.sep |
|
249 | pathsep = os.path.sep | |
250 | lpathsep = len(pathsep) |
|
250 | lpathsep = len(pathsep) | |
251 |
|
251 | |||
252 | out = [] |
|
252 | out = [] | |
253 | for (dirpath,dirnames,filenames) in os.walk(base): |
|
253 | for (dirpath,dirnames,filenames) in os.walk(base): | |
254 | # we need to strip out the dirpath from the base to map it to the |
|
254 | # we need to strip out the dirpath from the base to map it to the | |
255 | # output (installation) path. This requires possibly stripping the |
|
255 | # output (installation) path. This requires possibly stripping the | |
256 | # path separator, because otherwise pjoin will not work correctly |
|
256 | # path separator, because otherwise pjoin will not work correctly | |
257 | # (pjoin('foo/','/bar') returns '/bar'). |
|
257 | # (pjoin('foo/','/bar') returns '/bar'). | |
258 |
|
258 | |||
259 | dp_eff = dirpath[lbase:] |
|
259 | dp_eff = dirpath[lbase:] | |
260 | if dp_eff.startswith(pathsep): |
|
260 | if dp_eff.startswith(pathsep): | |
261 | dp_eff = dp_eff[lpathsep:] |
|
261 | dp_eff = dp_eff[lpathsep:] | |
262 | # The output path must be anchored at the out_base marker |
|
262 | # The output path must be anchored at the out_base marker | |
263 | out_path = pjoin(out_base,dp_eff) |
|
263 | out_path = pjoin(out_base,dp_eff) | |
264 | # Now we can generate the final filenames. Since os.walk only produces |
|
264 | # Now we can generate the final filenames. Since os.walk only produces | |
265 | # filenames, we must join back with the dirpath to get full valid file |
|
265 | # filenames, we must join back with the dirpath to get full valid file | |
266 | # paths: |
|
266 | # paths: | |
267 | pfiles = [pjoin(dirpath,f) for f in filenames] |
|
267 | pfiles = [pjoin(dirpath,f) for f in filenames] | |
268 | # Finally, generate the entry we need, which is a pari of (output |
|
268 | # Finally, generate the entry we need, which is a pari of (output | |
269 | # path, files) for use as a data_files parameter in install_data. |
|
269 | # path, files) for use as a data_files parameter in install_data. | |
270 | out.append((out_path, pfiles)) |
|
270 | out.append((out_path, pfiles)) | |
271 |
|
271 | |||
272 | return out |
|
272 | return out | |
273 |
|
273 | |||
274 |
|
274 | |||
275 | def find_data_files(): |
|
275 | def find_data_files(): | |
276 | """ |
|
276 | """ | |
277 | Find IPython's data_files. |
|
277 | Find IPython's data_files. | |
278 |
|
278 | |||
279 | Just man pages at this point. |
|
279 | Just man pages at this point. | |
280 | """ |
|
280 | """ | |
281 |
|
281 | |||
282 | manpagebase = pjoin('share', 'man', 'man1') |
|
282 | manpagebase = pjoin('share', 'man', 'man1') | |
283 |
|
283 | |||
284 | # Simple file lists can be made by hand |
|
284 | # Simple file lists can be made by hand | |
285 | manpages = [f for f in glob(pjoin('docs','man','*.1.gz')) if isfile(f)] |
|
285 | manpages = [f for f in glob(pjoin('docs','man','*.1.gz')) if isfile(f)] | |
286 | if not manpages: |
|
286 | if not manpages: | |
287 | # When running from a source tree, the manpages aren't gzipped |
|
287 | # When running from a source tree, the manpages aren't gzipped | |
288 | manpages = [f for f in glob(pjoin('docs','man','*.1')) if isfile(f)] |
|
288 | manpages = [f for f in glob(pjoin('docs','man','*.1')) if isfile(f)] | |
289 |
|
289 | |||
290 | # And assemble the entire output list |
|
290 | # And assemble the entire output list | |
291 | data_files = [ (manpagebase, manpages) ] |
|
291 | data_files = [ (manpagebase, manpages) ] | |
292 |
|
292 | |||
293 | return data_files |
|
293 | return data_files | |
294 |
|
294 | |||
295 |
|
295 | |||
296 | def make_man_update_target(manpage): |
|
296 | def make_man_update_target(manpage): | |
297 | """Return a target_update-compliant tuple for the given manpage. |
|
297 | """Return a target_update-compliant tuple for the given manpage. | |
298 |
|
298 | |||
299 | Parameters |
|
299 | Parameters | |
300 | ---------- |
|
300 | ---------- | |
301 | manpage : string |
|
301 | manpage : string | |
302 | Name of the manpage, must include the section number (trailing number). |
|
302 | Name of the manpage, must include the section number (trailing number). | |
303 |
|
303 | |||
304 | Example |
|
304 | Example | |
305 | ------- |
|
305 | ------- | |
306 |
|
306 | |||
307 | >>> make_man_update_target('ipython.1') #doctest: +NORMALIZE_WHITESPACE |
|
307 | >>> make_man_update_target('ipython.1') #doctest: +NORMALIZE_WHITESPACE | |
308 | ('docs/man/ipython.1.gz', |
|
308 | ('docs/man/ipython.1.gz', | |
309 | ['docs/man/ipython.1'], |
|
309 | ['docs/man/ipython.1'], | |
310 | 'cd docs/man && gzip -9c ipython.1 > ipython.1.gz') |
|
310 | 'cd docs/man && gzip -9c ipython.1 > ipython.1.gz') | |
311 | """ |
|
311 | """ | |
312 | man_dir = pjoin('docs', 'man') |
|
312 | man_dir = pjoin('docs', 'man') | |
313 | manpage_gz = manpage + '.gz' |
|
313 | manpage_gz = manpage + '.gz' | |
314 | manpath = pjoin(man_dir, manpage) |
|
314 | manpath = pjoin(man_dir, manpage) | |
315 | manpath_gz = pjoin(man_dir, manpage_gz) |
|
315 | manpath_gz = pjoin(man_dir, manpage_gz) | |
316 | gz_cmd = ( "cd %(man_dir)s && gzip -9c %(manpage)s > %(manpage_gz)s" % |
|
316 | gz_cmd = ( "cd %(man_dir)s && gzip -9c %(manpage)s > %(manpage_gz)s" % | |
317 | locals() ) |
|
317 | locals() ) | |
318 | return (manpath_gz, [manpath], gz_cmd) |
|
318 | return (manpath_gz, [manpath], gz_cmd) | |
319 |
|
319 | |||
320 | # The two functions below are copied from IPython.utils.path, so we don't need |
|
320 | # The two functions below are copied from IPython.utils.path, so we don't need | |
321 | # to import IPython during setup, which fails on Python 3. |
|
321 | # to import IPython during setup, which fails on Python 3. | |
322 |
|
322 | |||
323 | def target_outdated(target,deps): |
|
323 | def target_outdated(target,deps): | |
324 | """Determine whether a target is out of date. |
|
324 | """Determine whether a target is out of date. | |
325 |
|
325 | |||
326 | target_outdated(target,deps) -> 1/0 |
|
326 | target_outdated(target,deps) -> 1/0 | |
327 |
|
327 | |||
328 | deps: list of filenames which MUST exist. |
|
328 | deps: list of filenames which MUST exist. | |
329 | target: single filename which may or may not exist. |
|
329 | target: single filename which may or may not exist. | |
330 |
|
330 | |||
331 | If target doesn't exist or is older than any file listed in deps, return |
|
331 | If target doesn't exist or is older than any file listed in deps, return | |
332 | true, otherwise return false. |
|
332 | true, otherwise return false. | |
333 | """ |
|
333 | """ | |
334 | try: |
|
334 | try: | |
335 | target_time = os.path.getmtime(target) |
|
335 | target_time = os.path.getmtime(target) | |
336 | except os.error: |
|
336 | except os.error: | |
337 | return 1 |
|
337 | return 1 | |
338 | for dep in deps: |
|
338 | for dep in deps: | |
339 | dep_time = os.path.getmtime(dep) |
|
339 | dep_time = os.path.getmtime(dep) | |
340 | if dep_time > target_time: |
|
340 | if dep_time > target_time: | |
341 | #print "For target",target,"Dep failed:",dep # dbg |
|
341 | #print "For target",target,"Dep failed:",dep # dbg | |
342 | #print "times (dep,tar):",dep_time,target_time # dbg |
|
342 | #print "times (dep,tar):",dep_time,target_time # dbg | |
343 | return 1 |
|
343 | return 1 | |
344 | return 0 |
|
344 | return 0 | |
345 |
|
345 | |||
346 |
|
346 | |||
347 | def target_update(target,deps,cmd): |
|
347 | def target_update(target,deps,cmd): | |
348 | """Update a target with a given command given a list of dependencies. |
|
348 | """Update a target with a given command given a list of dependencies. | |
349 |
|
349 | |||
350 | target_update(target,deps,cmd) -> runs cmd if target is outdated. |
|
350 | target_update(target,deps,cmd) -> runs cmd if target is outdated. | |
351 |
|
351 | |||
352 | This is just a wrapper around target_outdated() which calls the given |
|
352 | This is just a wrapper around target_outdated() which calls the given | |
353 | command if target is outdated.""" |
|
353 | command if target is outdated.""" | |
354 |
|
354 | |||
355 | if target_outdated(target,deps): |
|
355 | if target_outdated(target,deps): | |
356 | os.system(cmd) |
|
356 | os.system(cmd) | |
357 |
|
357 | |||
358 | #--------------------------------------------------------------------------- |
|
358 | #--------------------------------------------------------------------------- | |
359 | # Find scripts |
|
359 | # Find scripts | |
360 | #--------------------------------------------------------------------------- |
|
360 | #--------------------------------------------------------------------------- | |
361 |
|
361 | |||
362 | def find_entry_points(): |
|
362 | def find_entry_points(): | |
363 | """Find IPython's scripts. |
|
363 | """Defines the command line entry points for IPython | |
364 |
|
364 | |||
365 | if entry_points is True: |
|
365 | This always uses setuptools-style entry points. When setuptools is not in | |
366 | return setuptools entry_point-style definitions |
|
366 | use, our own build_scripts_entrypt class below parses these and builds | |
367 | else: |
|
367 | command line scripts. | |
368 | return file paths of plain scripts [default] |
|
|||
369 |
|
368 | |||
370 | suffix is appended to script names if entry_points is True, so that the |
|
369 | Each of our entry points gets both a plain name, e.g. ipython, and one | |
371 | Python 3 scripts get named "ipython3" etc. |
|
370 | suffixed with the Python major version number, e.g. ipython3. | |
372 | """ |
|
371 | """ | |
373 | ep = [ |
|
372 | ep = [ | |
374 | 'ipython%s = IPython:start_ipython', |
|
373 | 'ipython%s = IPython:start_ipython', | |
375 | 'ipcontroller%s = IPython.parallel.apps.ipcontrollerapp:launch_new_instance', |
|
374 | 'ipcontroller%s = IPython.parallel.apps.ipcontrollerapp:launch_new_instance', | |
376 | 'ipengine%s = IPython.parallel.apps.ipengineapp:launch_new_instance', |
|
375 | 'ipengine%s = IPython.parallel.apps.ipengineapp:launch_new_instance', | |
377 | 'ipcluster%s = IPython.parallel.apps.ipclusterapp:launch_new_instance', |
|
376 | 'ipcluster%s = IPython.parallel.apps.ipclusterapp:launch_new_instance', | |
378 | 'iptest%s = IPython.testing.iptestcontroller:main', |
|
377 | 'iptest%s = IPython.testing.iptestcontroller:main', | |
379 | ] |
|
378 | ] | |
380 | suffix = str(sys.version_info[0]) |
|
379 | suffix = str(sys.version_info[0]) | |
381 | return [e % '' for e in ep] + [e % suffix for e in ep] |
|
380 | return [e % '' for e in ep] + [e % suffix for e in ep] | |
382 |
|
381 | |||
383 | script_src = """#!{executable} |
|
382 | script_src = """#!{executable} | |
384 | # This script was automatically generated by setup.py |
|
383 | # This script was automatically generated by setup.py | |
385 | if __name__ == '__main__': |
|
384 | if __name__ == '__main__': | |
386 | from {mod} import {func} |
|
385 | from {mod} import {func} | |
387 | {func}() |
|
386 | {func}() | |
388 | """ |
|
387 | """ | |
389 |
|
388 | |||
390 | class build_scripts_entrypt(build_scripts): |
|
389 | class build_scripts_entrypt(build_scripts): | |
|
390 | """Build the command line scripts | |||
|
391 | ||||
|
392 | Parse setuptools style entry points and write simple scripts to run the | |||
|
393 | target functions. | |||
|
394 | ||||
|
395 | On Windows, this also creates .cmd wrappers for the scripts so that you can | |||
|
396 | easily launch them from a command line. | |||
|
397 | """ | |||
391 | def run(self): |
|
398 | def run(self): | |
392 | self.mkpath(self.build_dir) |
|
399 | self.mkpath(self.build_dir) | |
393 | outfiles = [] |
|
400 | outfiles = [] | |
394 | for script in find_entry_points(): |
|
401 | for script in find_entry_points(): | |
395 | name, entrypt = script.split('=') |
|
402 | name, entrypt = script.split('=') | |
396 | name = name.strip() |
|
403 | name = name.strip() | |
397 | entrypt = entrypt.strip() |
|
404 | entrypt = entrypt.strip() | |
398 | outfile = os.path.join(self.build_dir, name) |
|
405 | outfile = os.path.join(self.build_dir, name) | |
399 | outfiles.append(outfile) |
|
406 | outfiles.append(outfile) | |
400 | print('Writing script to', outfile) |
|
407 | print('Writing script to', outfile) | |
401 |
|
408 | |||
402 | mod, func = entrypt.split(':') |
|
409 | mod, func = entrypt.split(':') | |
403 | with open(outfile, 'w') as f: |
|
410 | with open(outfile, 'w') as f: | |
404 | f.write(script_src.format(executable=sys.executable, |
|
411 | f.write(script_src.format(executable=sys.executable, | |
405 | mod=mod, func=func)) |
|
412 | mod=mod, func=func)) | |
|
413 | ||||
|
414 | if sys.platform == 'win32': | |||
|
415 | # Write .cmd wrappers for Windows so 'ipython' etc. work at the | |||
|
416 | # command line | |||
|
417 | cmd_file = os.path.join(self.build_dir, name + '.cmd') | |||
|
418 | cmd = '@"{python}" "%~dp0\{script}" %*\r\n'.format( | |||
|
419 | python=sys.executable, script=name) | |||
|
420 | log.info("Writing %s wrapper script" % cmd_file) | |||
|
421 | with open(cmd_file, 'w') as f: | |||
|
422 | f.write(cmd) | |||
406 |
|
423 | |||
407 | return outfiles, outfiles |
|
424 | return outfiles, outfiles | |
408 |
|
425 | |||
409 | class install_lib_symlink(Command): |
|
426 | class install_lib_symlink(Command): | |
410 | user_options = [ |
|
427 | user_options = [ | |
411 | ('install-dir=', 'd', "directory to install to"), |
|
428 | ('install-dir=', 'd', "directory to install to"), | |
412 | ] |
|
429 | ] | |
413 |
|
430 | |||
414 | def initialize_options(self): |
|
431 | def initialize_options(self): | |
415 | self.install_dir = None |
|
432 | self.install_dir = None | |
416 |
|
433 | |||
417 | def finalize_options(self): |
|
434 | def finalize_options(self): | |
418 | self.set_undefined_options('symlink', |
|
435 | self.set_undefined_options('symlink', | |
419 | ('install_lib', 'install_dir'), |
|
436 | ('install_lib', 'install_dir'), | |
420 | ) |
|
437 | ) | |
421 |
|
438 | |||
422 | def run(self): |
|
439 | def run(self): | |
423 | if sys.platform == 'win32': |
|
440 | if sys.platform == 'win32': | |
424 | raise Exception("This doesn't work on Windows.") |
|
441 | raise Exception("This doesn't work on Windows.") | |
425 | pkg = os.path.join(os.getcwd(), 'IPython') |
|
442 | pkg = os.path.join(os.getcwd(), 'IPython') | |
426 | dest = os.path.join(self.install_dir, 'IPython') |
|
443 | dest = os.path.join(self.install_dir, 'IPython') | |
427 | if os.path.islink(dest): |
|
444 | if os.path.islink(dest): | |
428 | print('removing existing symlink at %s' % dest) |
|
445 | print('removing existing symlink at %s' % dest) | |
429 | os.unlink(dest) |
|
446 | os.unlink(dest) | |
430 | print('symlinking %s -> %s' % (pkg, dest)) |
|
447 | print('symlinking %s -> %s' % (pkg, dest)) | |
431 | os.symlink(pkg, dest) |
|
448 | os.symlink(pkg, dest) | |
432 |
|
449 | |||
433 | class unsymlink(install): |
|
450 | class unsymlink(install): | |
434 | def run(self): |
|
451 | def run(self): | |
435 | dest = os.path.join(self.install_lib, 'IPython') |
|
452 | dest = os.path.join(self.install_lib, 'IPython') | |
436 | if os.path.islink(dest): |
|
453 | if os.path.islink(dest): | |
437 | print('removing symlink at %s' % dest) |
|
454 | print('removing symlink at %s' % dest) | |
438 | os.unlink(dest) |
|
455 | os.unlink(dest) | |
439 | else: |
|
456 | else: | |
440 | print('No symlink exists at %s' % dest) |
|
457 | print('No symlink exists at %s' % dest) | |
441 |
|
458 | |||
442 | class install_symlinked(install): |
|
459 | class install_symlinked(install): | |
443 | def run(self): |
|
460 | def run(self): | |
444 | if sys.platform == 'win32': |
|
461 | if sys.platform == 'win32': | |
445 | raise Exception("This doesn't work on Windows.") |
|
462 | raise Exception("This doesn't work on Windows.") | |
446 |
|
463 | |||
447 | # Run all sub-commands (at least those that need to be run) |
|
464 | # Run all sub-commands (at least those that need to be run) | |
448 | for cmd_name in self.get_sub_commands(): |
|
465 | for cmd_name in self.get_sub_commands(): | |
449 | self.run_command(cmd_name) |
|
466 | self.run_command(cmd_name) | |
450 |
|
467 | |||
451 | # 'sub_commands': a list of commands this command might have to run to |
|
468 | # 'sub_commands': a list of commands this command might have to run to | |
452 | # get its work done. See cmd.py for more info. |
|
469 | # get its work done. See cmd.py for more info. | |
453 | sub_commands = [('install_lib_symlink', lambda self:True), |
|
470 | sub_commands = [('install_lib_symlink', lambda self:True), | |
454 | ('install_scripts_sym', lambda self:True), |
|
471 | ('install_scripts_sym', lambda self:True), | |
455 | ] |
|
472 | ] | |
456 |
|
473 | |||
457 | class install_scripts_for_symlink(install_scripts): |
|
474 | class install_scripts_for_symlink(install_scripts): | |
458 | """Redefined to get options from 'symlink' instead of 'install'. |
|
475 | """Redefined to get options from 'symlink' instead of 'install'. | |
459 |
|
476 | |||
460 | I love distutils almost as much as I love setuptools. |
|
477 | I love distutils almost as much as I love setuptools. | |
461 | """ |
|
478 | """ | |
462 | def finalize_options(self): |
|
479 | def finalize_options(self): | |
463 | self.set_undefined_options('build', ('build_scripts', 'build_dir')) |
|
480 | self.set_undefined_options('build', ('build_scripts', 'build_dir')) | |
464 | self.set_undefined_options('symlink', |
|
481 | self.set_undefined_options('symlink', | |
465 | ('install_scripts', 'install_dir'), |
|
482 | ('install_scripts', 'install_dir'), | |
466 | ('force', 'force'), |
|
483 | ('force', 'force'), | |
467 | ('skip_build', 'skip_build'), |
|
484 | ('skip_build', 'skip_build'), | |
468 | ) |
|
485 | ) | |
469 |
|
486 | |||
470 | #--------------------------------------------------------------------------- |
|
487 | #--------------------------------------------------------------------------- | |
471 | # Verify all dependencies |
|
488 | # Verify all dependencies | |
472 | #--------------------------------------------------------------------------- |
|
489 | #--------------------------------------------------------------------------- | |
473 |
|
490 | |||
474 | def check_for_dependencies(): |
|
491 | def check_for_dependencies(): | |
475 | """Check for IPython's dependencies. |
|
492 | """Check for IPython's dependencies. | |
476 |
|
493 | |||
477 | This function should NOT be called if running under setuptools! |
|
494 | This function should NOT be called if running under setuptools! | |
478 | """ |
|
495 | """ | |
479 | from setupext.setupext import ( |
|
496 | from setupext.setupext import ( | |
480 | print_line, print_raw, print_status, |
|
497 | print_line, print_raw, print_status, | |
481 | check_for_sphinx, check_for_pygments, |
|
498 | check_for_sphinx, check_for_pygments, | |
482 | check_for_nose, check_for_pexpect, |
|
499 | check_for_nose, check_for_pexpect, | |
483 | check_for_pyzmq, check_for_readline, |
|
500 | check_for_pyzmq, check_for_readline, | |
484 | check_for_jinja2, check_for_tornado |
|
501 | check_for_jinja2, check_for_tornado | |
485 | ) |
|
502 | ) | |
486 | print_line() |
|
503 | print_line() | |
487 | print_raw("BUILDING IPYTHON") |
|
504 | print_raw("BUILDING IPYTHON") | |
488 | print_status('python', sys.version) |
|
505 | print_status('python', sys.version) | |
489 | print_status('platform', sys.platform) |
|
506 | print_status('platform', sys.platform) | |
490 | if sys.platform == 'win32': |
|
507 | if sys.platform == 'win32': | |
491 | print_status('Windows version', sys.getwindowsversion()) |
|
508 | print_status('Windows version', sys.getwindowsversion()) | |
492 |
|
509 | |||
493 | print_raw("") |
|
510 | print_raw("") | |
494 | print_raw("OPTIONAL DEPENDENCIES") |
|
511 | print_raw("OPTIONAL DEPENDENCIES") | |
495 |
|
512 | |||
496 | check_for_sphinx() |
|
513 | check_for_sphinx() | |
497 | check_for_pygments() |
|
514 | check_for_pygments() | |
498 | check_for_nose() |
|
515 | check_for_nose() | |
499 | if os.name == 'posix': |
|
516 | if os.name == 'posix': | |
500 | check_for_pexpect() |
|
517 | check_for_pexpect() | |
501 | check_for_pyzmq() |
|
518 | check_for_pyzmq() | |
502 | check_for_tornado() |
|
519 | check_for_tornado() | |
503 | check_for_readline() |
|
520 | check_for_readline() | |
504 | check_for_jinja2() |
|
521 | check_for_jinja2() | |
505 |
|
522 | |||
506 | #--------------------------------------------------------------------------- |
|
523 | #--------------------------------------------------------------------------- | |
507 | # VCS related |
|
524 | # VCS related | |
508 | #--------------------------------------------------------------------------- |
|
525 | #--------------------------------------------------------------------------- | |
509 |
|
526 | |||
510 | # utils.submodule has checks for submodule status |
|
527 | # utils.submodule has checks for submodule status | |
511 | execfile(pjoin('IPython','utils','submodule.py'), globals()) |
|
528 | execfile(pjoin('IPython','utils','submodule.py'), globals()) | |
512 |
|
529 | |||
513 | class UpdateSubmodules(Command): |
|
530 | class UpdateSubmodules(Command): | |
514 | """Update git submodules |
|
531 | """Update git submodules | |
515 |
|
532 | |||
516 | IPython's external javascript dependencies live in a separate repo. |
|
533 | IPython's external javascript dependencies live in a separate repo. | |
517 | """ |
|
534 | """ | |
518 | description = "Update git submodules" |
|
535 | description = "Update git submodules" | |
519 | user_options = [] |
|
536 | user_options = [] | |
520 |
|
537 | |||
521 | def initialize_options(self): |
|
538 | def initialize_options(self): | |
522 | pass |
|
539 | pass | |
523 |
|
540 | |||
524 | def finalize_options(self): |
|
541 | def finalize_options(self): | |
525 | pass |
|
542 | pass | |
526 |
|
543 | |||
527 | def run(self): |
|
544 | def run(self): | |
528 | failure = False |
|
545 | failure = False | |
529 | try: |
|
546 | try: | |
530 | self.spawn('git submodule init'.split()) |
|
547 | self.spawn('git submodule init'.split()) | |
531 | self.spawn('git submodule update --recursive'.split()) |
|
548 | self.spawn('git submodule update --recursive'.split()) | |
532 | except Exception as e: |
|
549 | except Exception as e: | |
533 | failure = e |
|
550 | failure = e | |
534 | print(e) |
|
551 | print(e) | |
535 |
|
552 | |||
536 | if not check_submodule_status(repo_root) == 'clean': |
|
553 | if not check_submodule_status(repo_root) == 'clean': | |
537 | print("submodules could not be checked out") |
|
554 | print("submodules could not be checked out") | |
538 | sys.exit(1) |
|
555 | sys.exit(1) | |
539 |
|
556 | |||
540 |
|
557 | |||
541 | def git_prebuild(pkg_dir, build_cmd=build_py): |
|
558 | def git_prebuild(pkg_dir, build_cmd=build_py): | |
542 | """Return extended build or sdist command class for recording commit |
|
559 | """Return extended build or sdist command class for recording commit | |
543 |
|
560 | |||
544 | records git commit in IPython.utils._sysinfo.commit |
|
561 | records git commit in IPython.utils._sysinfo.commit | |
545 |
|
562 | |||
546 | for use in IPython.utils.sysinfo.sys_info() calls after installation. |
|
563 | for use in IPython.utils.sysinfo.sys_info() calls after installation. | |
547 |
|
564 | |||
548 | Also ensures that submodules exist prior to running |
|
565 | Also ensures that submodules exist prior to running | |
549 | """ |
|
566 | """ | |
550 |
|
567 | |||
551 | class MyBuildPy(build_cmd): |
|
568 | class MyBuildPy(build_cmd): | |
552 | ''' Subclass to write commit data into installation tree ''' |
|
569 | ''' Subclass to write commit data into installation tree ''' | |
553 | def run(self): |
|
570 | def run(self): | |
554 | build_cmd.run(self) |
|
571 | build_cmd.run(self) | |
555 | # this one will only fire for build commands |
|
572 | # this one will only fire for build commands | |
556 | if hasattr(self, 'build_lib'): |
|
573 | if hasattr(self, 'build_lib'): | |
557 | self._record_commit(self.build_lib) |
|
574 | self._record_commit(self.build_lib) | |
558 |
|
575 | |||
559 | def make_release_tree(self, base_dir, files): |
|
576 | def make_release_tree(self, base_dir, files): | |
560 | # this one will fire for sdist |
|
577 | # this one will fire for sdist | |
561 | build_cmd.make_release_tree(self, base_dir, files) |
|
578 | build_cmd.make_release_tree(self, base_dir, files) | |
562 | self._record_commit(base_dir) |
|
579 | self._record_commit(base_dir) | |
563 |
|
580 | |||
564 | def _record_commit(self, base_dir): |
|
581 | def _record_commit(self, base_dir): | |
565 | import subprocess |
|
582 | import subprocess | |
566 | proc = subprocess.Popen('git rev-parse --short HEAD', |
|
583 | proc = subprocess.Popen('git rev-parse --short HEAD', | |
567 | stdout=subprocess.PIPE, |
|
584 | stdout=subprocess.PIPE, | |
568 | stderr=subprocess.PIPE, |
|
585 | stderr=subprocess.PIPE, | |
569 | shell=True) |
|
586 | shell=True) | |
570 | repo_commit, _ = proc.communicate() |
|
587 | repo_commit, _ = proc.communicate() | |
571 | repo_commit = repo_commit.strip().decode("ascii") |
|
588 | repo_commit = repo_commit.strip().decode("ascii") | |
572 |
|
589 | |||
573 | out_pth = pjoin(base_dir, pkg_dir, 'utils', '_sysinfo.py') |
|
590 | out_pth = pjoin(base_dir, pkg_dir, 'utils', '_sysinfo.py') | |
574 | if os.path.isfile(out_pth) and not repo_commit: |
|
591 | if os.path.isfile(out_pth) and not repo_commit: | |
575 | # nothing to write, don't clobber |
|
592 | # nothing to write, don't clobber | |
576 | return |
|
593 | return | |
577 |
|
594 | |||
578 | print("writing git commit '%s' to %s" % (repo_commit, out_pth)) |
|
595 | print("writing git commit '%s' to %s" % (repo_commit, out_pth)) | |
579 |
|
596 | |||
580 | # remove to avoid overwriting original via hard link |
|
597 | # remove to avoid overwriting original via hard link | |
581 | try: |
|
598 | try: | |
582 | os.remove(out_pth) |
|
599 | os.remove(out_pth) | |
583 | except (IOError, OSError): |
|
600 | except (IOError, OSError): | |
584 | pass |
|
601 | pass | |
585 | with open(out_pth, 'w') as out_file: |
|
602 | with open(out_pth, 'w') as out_file: | |
586 | out_file.writelines([ |
|
603 | out_file.writelines([ | |
587 | '# GENERATED BY setup.py\n', |
|
604 | '# GENERATED BY setup.py\n', | |
588 | 'commit = u"%s"\n' % repo_commit, |
|
605 | 'commit = u"%s"\n' % repo_commit, | |
589 | ]) |
|
606 | ]) | |
590 | return require_submodules(MyBuildPy) |
|
607 | return require_submodules(MyBuildPy) | |
591 |
|
608 | |||
592 |
|
609 | |||
593 | def require_submodules(command): |
|
610 | def require_submodules(command): | |
594 | """decorator for instructing a command to check for submodules before running""" |
|
611 | """decorator for instructing a command to check for submodules before running""" | |
595 | class DecoratedCommand(command): |
|
612 | class DecoratedCommand(command): | |
596 | def run(self): |
|
613 | def run(self): | |
597 | if not check_submodule_status(repo_root) == 'clean': |
|
614 | if not check_submodule_status(repo_root) == 'clean': | |
598 | print("submodules missing! Run `setup.py submodule` and try again") |
|
615 | print("submodules missing! Run `setup.py submodule` and try again") | |
599 | sys.exit(1) |
|
616 | sys.exit(1) | |
600 | command.run(self) |
|
617 | command.run(self) | |
601 | return DecoratedCommand |
|
618 | return DecoratedCommand | |
602 |
|
619 | |||
603 | #--------------------------------------------------------------------------- |
|
620 | #--------------------------------------------------------------------------- | |
604 | # bdist related |
|
621 | # bdist related | |
605 | #--------------------------------------------------------------------------- |
|
622 | #--------------------------------------------------------------------------- | |
606 |
|
623 | |||
607 | def get_bdist_wheel(): |
|
624 | def get_bdist_wheel(): | |
608 | """Construct bdist_wheel command for building wheels |
|
625 | """Construct bdist_wheel command for building wheels | |
609 |
|
626 | |||
610 | Constructs py2-none-any tag, instead of py2.7-none-any |
|
627 | Constructs py2-none-any tag, instead of py2.7-none-any | |
611 | """ |
|
628 | """ | |
612 | class RequiresWheel(Command): |
|
629 | class RequiresWheel(Command): | |
613 | description = "Dummy command for missing bdist_wheel" |
|
630 | description = "Dummy command for missing bdist_wheel" | |
614 | user_options = [] |
|
631 | user_options = [] | |
615 |
|
632 | |||
616 | def initialize_options(self): |
|
633 | def initialize_options(self): | |
617 | pass |
|
634 | pass | |
618 |
|
635 | |||
619 | def finalize_options(self): |
|
636 | def finalize_options(self): | |
620 | pass |
|
637 | pass | |
621 |
|
638 | |||
622 | def run(self): |
|
639 | def run(self): | |
623 | print("bdist_wheel requires the wheel package") |
|
640 | print("bdist_wheel requires the wheel package") | |
624 | sys.exit(1) |
|
641 | sys.exit(1) | |
625 |
|
642 | |||
626 | if 'setuptools' not in sys.modules: |
|
643 | if 'setuptools' not in sys.modules: | |
627 | return RequiresWheel |
|
644 | return RequiresWheel | |
628 | else: |
|
645 | else: | |
629 | try: |
|
646 | try: | |
630 | from wheel.bdist_wheel import bdist_wheel, read_pkg_info, write_pkg_info |
|
647 | from wheel.bdist_wheel import bdist_wheel, read_pkg_info, write_pkg_info | |
631 | except ImportError: |
|
648 | except ImportError: | |
632 | return RequiresWheel |
|
649 | return RequiresWheel | |
633 |
|
650 | |||
634 | class bdist_wheel_tag(bdist_wheel): |
|
651 | class bdist_wheel_tag(bdist_wheel): | |
635 |
|
652 | |||
636 | def add_requirements(self, metadata_path): |
|
653 | def add_requirements(self, metadata_path): | |
637 | """transform platform-dependent requirements""" |
|
654 | """transform platform-dependent requirements""" | |
638 | pkg_info = read_pkg_info(metadata_path) |
|
655 | pkg_info = read_pkg_info(metadata_path) | |
639 | # pkg_info is an email.Message object (?!) |
|
656 | # pkg_info is an email.Message object (?!) | |
640 | # we have to remove the unconditional 'readline' and/or 'pyreadline' entries |
|
657 | # we have to remove the unconditional 'readline' and/or 'pyreadline' entries | |
641 | # and transform them to conditionals |
|
658 | # and transform them to conditionals | |
642 | requires = pkg_info.get_all('Requires-Dist') |
|
659 | requires = pkg_info.get_all('Requires-Dist') | |
643 | del pkg_info['Requires-Dist'] |
|
660 | del pkg_info['Requires-Dist'] | |
644 | def _remove_startswith(lis, prefix): |
|
661 | def _remove_startswith(lis, prefix): | |
645 | """like list.remove, but with startswith instead of ==""" |
|
662 | """like list.remove, but with startswith instead of ==""" | |
646 | found = False |
|
663 | found = False | |
647 | for idx, item in enumerate(lis): |
|
664 | for idx, item in enumerate(lis): | |
648 | if item.startswith(prefix): |
|
665 | if item.startswith(prefix): | |
649 | found = True |
|
666 | found = True | |
650 | break |
|
667 | break | |
651 | if found: |
|
668 | if found: | |
652 | lis.pop(idx) |
|
669 | lis.pop(idx) | |
653 |
|
670 | |||
654 | for pkg in ("gnureadline", "pyreadline", "mock"): |
|
671 | for pkg in ("gnureadline", "pyreadline", "mock"): | |
655 | _remove_startswith(requires, pkg) |
|
672 | _remove_startswith(requires, pkg) | |
656 | requires.append("gnureadline; sys.platform == 'darwin' and platform.python_implementation == 'CPython'") |
|
673 | requires.append("gnureadline; sys.platform == 'darwin' and platform.python_implementation == 'CPython'") | |
657 | requires.append("pyreadline (>=2.0); extra == 'terminal' and sys.platform == 'win32' and platform.python_implementation == 'CPython'") |
|
674 | requires.append("pyreadline (>=2.0); extra == 'terminal' and sys.platform == 'win32' and platform.python_implementation == 'CPython'") | |
658 | requires.append("pyreadline (>=2.0); extra == 'all' and sys.platform == 'win32' and platform.python_implementation == 'CPython'") |
|
675 | requires.append("pyreadline (>=2.0); extra == 'all' and sys.platform == 'win32' and platform.python_implementation == 'CPython'") | |
659 | requires.append("mock; extra == 'test' and python_version < '3.3'") |
|
676 | requires.append("mock; extra == 'test' and python_version < '3.3'") | |
660 | for r in requires: |
|
677 | for r in requires: | |
661 | pkg_info['Requires-Dist'] = r |
|
678 | pkg_info['Requires-Dist'] = r | |
662 | write_pkg_info(metadata_path, pkg_info) |
|
679 | write_pkg_info(metadata_path, pkg_info) | |
663 |
|
680 | |||
664 | return bdist_wheel_tag |
|
681 | return bdist_wheel_tag | |
665 |
|
682 | |||
666 | #--------------------------------------------------------------------------- |
|
683 | #--------------------------------------------------------------------------- | |
667 | # Notebook related |
|
684 | # Notebook related | |
668 | #--------------------------------------------------------------------------- |
|
685 | #--------------------------------------------------------------------------- | |
669 |
|
686 | |||
670 | class CompileCSS(Command): |
|
687 | class CompileCSS(Command): | |
671 | """Recompile Notebook CSS |
|
688 | """Recompile Notebook CSS | |
672 |
|
689 | |||
673 | Regenerate the compiled CSS from LESS sources. |
|
690 | Regenerate the compiled CSS from LESS sources. | |
674 |
|
691 | |||
675 | Requires various dev dependencies, such as invoke and lessc. |
|
692 | Requires various dev dependencies, such as invoke and lessc. | |
676 | """ |
|
693 | """ | |
677 | description = "Recompile Notebook CSS" |
|
694 | description = "Recompile Notebook CSS" | |
678 | user_options = [ |
|
695 | user_options = [ | |
679 | ('minify', 'x', "minify CSS"), |
|
696 | ('minify', 'x', "minify CSS"), | |
680 | ('force', 'f', "force recompilation of CSS"), |
|
697 | ('force', 'f', "force recompilation of CSS"), | |
681 | ] |
|
698 | ] | |
682 |
|
699 | |||
683 | def initialize_options(self): |
|
700 | def initialize_options(self): | |
684 | self.minify = False |
|
701 | self.minify = False | |
685 | self.force = False |
|
702 | self.force = False | |
686 |
|
703 | |||
687 | def finalize_options(self): |
|
704 | def finalize_options(self): | |
688 | self.minify = bool(self.minify) |
|
705 | self.minify = bool(self.minify) | |
689 | self.force = bool(self.force) |
|
706 | self.force = bool(self.force) | |
690 |
|
707 | |||
691 | def run(self): |
|
708 | def run(self): | |
692 | cmd = ['invoke', 'css'] |
|
709 | cmd = ['invoke', 'css'] | |
693 | if self.minify: |
|
710 | if self.minify: | |
694 | cmd.append('--minify') |
|
711 | cmd.append('--minify') | |
695 | if self.force: |
|
712 | if self.force: | |
696 | cmd.append('--force') |
|
713 | cmd.append('--force') | |
697 | check_call(cmd, cwd=pjoin(repo_root, "IPython", "html")) |
|
714 | check_call(cmd, cwd=pjoin(repo_root, "IPython", "html")) | |
698 |
|
715 | |||
699 |
|
716 | |||
700 | class JavascriptVersion(Command): |
|
717 | class JavascriptVersion(Command): | |
701 | """write the javascript version to notebook javascript""" |
|
718 | """write the javascript version to notebook javascript""" | |
702 | description = "Write IPython version to javascript" |
|
719 | description = "Write IPython version to javascript" | |
703 | user_options = [] |
|
720 | user_options = [] | |
704 |
|
721 | |||
705 | def initialize_options(self): |
|
722 | def initialize_options(self): | |
706 | pass |
|
723 | pass | |
707 |
|
724 | |||
708 | def finalize_options(self): |
|
725 | def finalize_options(self): | |
709 | pass |
|
726 | pass | |
710 |
|
727 | |||
711 | def run(self): |
|
728 | def run(self): | |
712 | nsfile = pjoin(repo_root, "IPython", "html", "static", "base", "js", "namespace.js") |
|
729 | nsfile = pjoin(repo_root, "IPython", "html", "static", "base", "js", "namespace.js") | |
713 | with open(nsfile) as f: |
|
730 | with open(nsfile) as f: | |
714 | lines = f.readlines() |
|
731 | lines = f.readlines() | |
715 | with open(nsfile, 'w') as f: |
|
732 | with open(nsfile, 'w') as f: | |
716 | for line in lines: |
|
733 | for line in lines: | |
717 | if line.startswith("IPython.version"): |
|
734 | if line.startswith("IPython.version"): | |
718 | line = 'IPython.version = "{0}";\n'.format(version) |
|
735 | line = 'IPython.version = "{0}";\n'.format(version) | |
719 | f.write(line) |
|
736 | f.write(line) | |
720 |
|
737 | |||
721 |
|
738 | |||
722 | def css_js_prerelease(command, strict=True): |
|
739 | def css_js_prerelease(command, strict=True): | |
723 | """decorator for building js/minified css prior to a release""" |
|
740 | """decorator for building js/minified css prior to a release""" | |
724 | class DecoratedCommand(command): |
|
741 | class DecoratedCommand(command): | |
725 | def run(self): |
|
742 | def run(self): | |
726 | self.distribution.run_command('jsversion') |
|
743 | self.distribution.run_command('jsversion') | |
727 | css = self.distribution.get_command_obj('css') |
|
744 | css = self.distribution.get_command_obj('css') | |
728 | css.minify = True |
|
745 | css.minify = True | |
729 | try: |
|
746 | try: | |
730 | self.distribution.run_command('css') |
|
747 | self.distribution.run_command('css') | |
731 | except Exception as e: |
|
748 | except Exception as e: | |
732 | if strict: |
|
749 | if strict: | |
733 | raise |
|
750 | raise | |
734 | else: |
|
751 | else: | |
735 | log.warn("Failed to build css sourcemaps: %s" % e) |
|
752 | log.warn("Failed to build css sourcemaps: %s" % e) | |
736 | command.run(self) |
|
753 | command.run(self) | |
737 | return DecoratedCommand |
|
754 | return DecoratedCommand |
General Comments 0
You need to be logged in to leave comments.
Login now