##// END OF EJS Templates
Remove incorrect type=int conversion for commandline usage
codespaced -
Show More
@@ -1,316 +1,315 b''
1 1 #!/usr/bin/python
2 2 """Utility function for installing MathJax javascript library into
3 3 the notebook's 'static' directory, for offline use.
4 4
5 5 Authors:
6 6
7 7 * Min RK
8 8 * Mark Sienkiewicz
9 9 * Matthias Bussonnier
10 10
11 11 To download and install MathJax:
12 12
13 13 From Python:
14 14
15 15 >>> from IPython.external.mathjax import install_mathjax
16 16 >>> install_mathjax()
17 17
18 18 From the command line:
19 19
20 20 $ python -m IPython.external.mathjax
21 21
22 22 To install MathJax from a file you have already downloaded:
23 23
24 24 $ python -m IPython.external.mathjax mathjax-xxx.tar.gz
25 25 $ python -m IPython.external.mathjax mathjax-xxx.zip
26 26
27 27 It will not install MathJax if it is already there. Use -r to
28 28 replace the existing copy of MathJax.
29 29
30 30 To find the directory where IPython would like MathJax installed:
31 31
32 32 $ python -m IPython.external.mathjax -d
33 33
34 34 """
35 35
36 36
37 37 #-----------------------------------------------------------------------------
38 38 # Copyright (C) 2008-2011 The IPython Development Team
39 39 #
40 40 # Distributed under the terms of the BSD License. The full license is in
41 41 # the file COPYING, distributed as part of this software.
42 42 #-----------------------------------------------------------------------------
43 43
44 44
45 45 #-----------------------------------------------------------------------------
46 46 # Imports
47 47 #-----------------------------------------------------------------------------
48 48
49 49 import os
50 50 import shutil
51 51 import sys
52 52 import tarfile
53 53 import urllib2
54 54 import zipfile
55 55
56 56
57 57 from IPython.utils.path import locate_profile
58 58 from IPython.external import argparse
59 59 #-----------------------------------------------------------------------------
60 60 #
61 61 #-----------------------------------------------------------------------------
62 62
63 63 # Where mathjax will be installed.
64 64
65 65 static = os.path.join(locate_profile('default'), 'static')
66 66 default_dest = os.path.join(static, 'mathjax')
67 67
68 68 ##
69 69
70 70 # Test for access to install mathjax.
71 71
72 72 def check_perms(dest, replace=False):
73 73 parent = os.path.abspath(os.path.join(dest, os.path.pardir))
74 74 components = dest.split(os.path.sep)
75 75 subpaths = [ os.path.sep+os.path.sep.join(components[1:i]) for i in range(1,len(components))]
76 76
77 77 existing_path = filter(os.path.exists, subpaths)
78 78 last_writable = existing_path[-1]
79 79 if not os.access(last_writable, os.W_OK):
80 80 raise IOError("Need have write access to %s" % parent)
81 81 not_existing = [ path for path in subpaths if path not in existing_path]
82 82 # subfolder we will create, will obviously be writable
83 83 # should we still considere checking separately that
84 84 # ipython profiles have been created ?
85 85 for folder in not_existing:
86 86 os.mkdir(folder)
87 87
88 88 if os.path.exists(dest):
89 89 if replace:
90 90 if not os.access(dest, os.W_OK):
91 91 raise IOError("Need have write access to %s" % dest)
92 92 print "removing previous MathJax install"
93 93 shutil.rmtree(dest)
94 94 return True
95 95 else:
96 96 print "offline MathJax apparently already installed"
97 97 return False
98 98 else :
99 99 return True
100 100
101 101 ##
102 102
103 103 def extract_tar( fd, dest ) :
104 104 # use 'r|gz' stream mode, because socket file-like objects can't seek:
105 105 tar = tarfile.open(fileobj=fd, mode='r|gz')
106 106
107 107 # we just happen to know that the first entry in the mathjax
108 108 # archive is the directory that the remaining members are in.
109 109 topdir = tar.firstmember.path
110 110
111 111 # extract the archive (contains a single directory) to the static/ directory
112 112 parent = os.path.abspath(os.path.join(dest, os.path.pardir))
113 113 tar.extractall(parent)
114 114
115 115 # it will be mathjax-MathJax-<sha>, rename to just mathjax
116 116 os.rename(os.path.join(parent, topdir), dest)
117 117
118 118 ##
119 119
120 120 def extract_zip( fd, dest ) :
121 121 z = zipfile.ZipFile( fd, 'r' )
122 122
123 123 # we just happen to know that the first entry in the mathjax
124 124 # archive is the directory that the remaining members are in.
125 125 topdir = z.namelist()[0]
126 126
127 127 # extract the archive (contains a single directory) to the static/ directory
128 128 parent = os.path.abspath(os.path.join(dest, os.path.pardir))
129 129 z.extractall( parent )
130 130
131 131 # it will be mathjax-MathJax-<sha>, rename to just mathjax
132 132 d = os.path.join(parent, topdir)
133 133 print d
134 134 os.rename(os.path.join(parent, topdir), dest)
135 135
136 136 ##
137 137
138 138 def install_mathjax(tag='v2.0', dest=default_dest, replace=False, file=None, extractor=extract_tar ):
139 139 """Download and/or install MathJax for offline use.
140 140
141 141 This will install mathjax to the 'static' dir in the IPython notebook
142 142 package, so it will fail if the caller does not have write access
143 143 to that location.
144 144
145 145 MathJax is a ~15MB download, and ~150MB installed.
146 146
147 147 Parameters
148 148 ----------
149 149
150 150 replace : bool [False]
151 151 Whether to remove and replace an existing install.
152 152 dest : str [path to default profile]
153 153 Where to locally install mathjax
154 154 tag : str ['v2.0']
155 155 Which tag to download. Default is 'v2.0', the current stable release,
156 156 but alternatives include 'v1.1a' and 'master'.
157 157 file : file like object [ defualt to content of https://github.com/mathjax/MathJax/tarball/#{tag}]
158 158 File handle from which to untar/unzip/... mathjax
159 159 extractor : function
160 160 Method tu use to untar/unzip/... `file`
161 161 """
162 162 if not check_perms(dest, replace) :
163 163 return
164 164
165 165 if file is None :
166 166 # download mathjax
167 167 mathjax_url = "https://github.com/mathjax/MathJax/tarball/%s" % tag
168 168 print "Downloading mathjax source from %s" % mathjax_url
169 169 response = urllib2.urlopen(mathjax_url)
170 170 file = response.fp
171 171
172 172 print "Extracting to %s" % dest
173 173 extractor( file, dest )
174 174
175 175 ##
176 176
177 177 def test_func( remove, dest) :
178 178 """See if mathjax appears to be installed correctly"""
179 179 status = 0
180 180 if not os.path.isdir( dest ) :
181 181 print "%s directory not found" % dest
182 182 status = 1
183 183 if not os.path.exists( dest + "/MathJax.js" ) :
184 184 print "MathJax.js not present in %s" % dest
185 185 status = 1
186 186 print "ok"
187 187 if remove and os.path.exists(dest):
188 188 shutil.rmtree( dest )
189 189 return status
190 190
191 191 ##
192 192
193 193 def main() :
194 194 # This main is just simple enough that it is not worth the
195 195 # complexity of argparse
196 196
197 197 # What directory is mathjax in?
198 198 parser = argparse.ArgumentParser(
199 199 description="""Install mathjax from internet or local archive""",
200 200 )
201 201
202 202 parser.add_argument(
203 203 '-i',
204 204 '--install-dir',
205 205 default=default_dest,
206 206 help='installation directory (by default : %s)' % (default_dest))
207 207 parser.add_argument(
208 208 '-d',
209 209 '--dest',
210 210 action='store_true',
211 211 help='print where is current mathjax would be installed and exit')
212 212 parser.add_argument(
213 213 '-r',
214 214 '--replace',
215 215 action='store_true',
216 216 help='Wether to replace current mathjax if already exist')
217 217 parser.add_argument(
218 218 '-t',
219 219 '--test',
220 220 action='store_true')
221 221 parser.add_argument('tarball',
222 type=int,
223 222 help="the local tar/zip-ball containing mathjax",
224 223 nargs='?',
225 224 metavar='tarball')
226 225
227 226 pargs = parser.parse_args()
228 227
229 228 dest = pargs.install_dir
230 229 if pargs.dest :
231 230 print dest
232 231 return
233 232
234 233 # remove/replace existing mathjax?
235 234 if pargs.replace :
236 235 replace = True
237 236 else :
238 237 replace = False
239 238
240 239 # undocumented test interface
241 240 if pargs.test :
242 241 return test_func( replace, dest)
243 242
244 243 # do it
245 244 if pargs.tarball :
246 245 fname = pargs.tarball
247 246
248 247 # automatically detect zip/tar - could do something based
249 248 # on file content, but really not cost-effective here.
250 249 if fname.endswith('.zip') :
251 250 extractor = extract_zip
252 251 else :
253 252 extractor = extract_tar
254 253 # do it
255 254 install_mathjax(file=open(fname, "r"), replace=replace, extractor=extractor, dest=dest )
256 255 else:
257 256 install_mathjax(replace=replace, dest=dest)
258 257
259 258
260 259 if __name__ == '__main__' :
261 260 sys.exit(main())
262 261
263 262 __all__ = ['install_mathjax', 'main', 'dest']
264 263
265 264 """
266 265 Test notes:
267 266
268 267 IPython uses IPython.testing.iptest as a custom test controller
269 268 (though it is based on nose). It might be possible to fit automatic
270 269 tests of installation into that framework, but it looks awkward to me.
271 270 So, here is a manual procedure for testing this automatic installer.
272 271
273 272 Mark Sienkiewicz, 2012-08-06
274 273 first 8 letters of my last name @ stsci.edu
275 274
276 275 # remove mathjax from the installed ipython instance
277 276 # IOError ok if mathjax was never installed yet.
278 277
279 278 python -m IPython.external.mathjax --test -r
280 279
281 280 # download and install mathjax from command line:
282 281
283 282 python -m IPython.external.mathjax
284 283 python -m IPython.external.mathjax --test -r
285 284
286 285 # download and install from within python
287 286
288 287 python -c "from IPython.external.mathjax import install_mathjax; install_mathjax()"
289 288 python -m IPython.external.mathjax --test -r
290 289
291 290 # view http://www.mathjax.org/download/ in your browser
292 291 # save-as the link for MathJax-2.0 near the bottom of the page.
293 292 # The file it offers is mathjax-MathJax-v2.0-20-g07669ac.zip
294 293
295 294 python -m IPython.external.mathjax mathjax-MathJax-v2.0-20-g07669ac.zip
296 295 python -m IPython.external.mathjax --test -r
297 296
298 297 # download https://github.com/mathjax/MathJax/tarball/v2.0 in your browser
299 298 # (this is the url used internally by install_mathjax)
300 299 # The file it offers is mathjax-MathJax-v2.0-20-g07669ac.tar.gz
301 300
302 301 python -m IPython.external.mathjax mathjax-MathJax-v2.0-20-g07669ac.tar.gz
303 302
304 303 python -m IPython.external.mathjax --test
305 304 # note no -r
306 305
307 306 # install it again while it is already there
308 307
309 308 python -m IPython.external.mathjax mathjax-MathJax-v2.0-20-g07669ac.tar.gz
310 309 # says "offline MathJax apparently already installed"
311 310
312 311 python -m IPython.external.mathjax ~/mathjax-MathJax-v2.0-20-g07669ac.tar.gz
313 312 python -m IPython.external.mathjax --test
314 313
315 314
316 315 """
General Comments 0
You need to be logged in to leave comments. Login now