2 """Bootstrap setuptools installation
4 If you want to use setuptools in your package's setup.py, just include this
5 file in the same directory with it, and add this to the top of your setup.py::
7 from ez_setup import use_setuptools
10 If you want to require a specific version of setuptools, set a download
11 mirror, or use an alternate download directory, you can do so by supplying
12 the appropriate options to ``use_setuptools()``.
14 This file can also be run as a script to install or upgrade setuptools.
17 DEFAULT_VERSION
= "0.6c7"
18 DEFAULT_URL
= "http://pypi.python.org/packages/%s/s/setuptools/" % sys
.version
[:3]
21 'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca',
22 'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb',
23 'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b',
24 'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a',
25 'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618',
26 'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac',
27 'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5',
28 'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4',
29 'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c',
30 'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b',
31 'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27',
32 'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277',
33 'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa',
34 'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e',
35 'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e',
36 'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f',
37 'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2',
38 'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc',
39 'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167',
40 'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64',
41 'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d',
42 'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20',
43 'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab',
44 'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53',
49 def _validate_md5(egg_name
, data
):
50 if egg_name
in md5_data
:
52 digest
= md5(data
).hexdigest()
53 if digest
!= md5_data
[egg_name
]:
55 "md5 validation of %s failed! (Possible download problem?)"
63 version
=DEFAULT_VERSION
, download_base
=DEFAULT_URL
, to_dir
=os
.curdir
, min_version
=None,
66 """Automatically find/download setuptools and make it available on sys.path
68 `version` should be a valid setuptools version number that is available
69 as an egg for download under the `download_base` URL (which should end with
70 a '/'). `to_dir` is the directory where setuptools will be downloaded, if
71 it is not already available. If `download_delay` is specified, it should
72 be the number of seconds that will be paused before initiating a download,
73 should one be required. If an older version of setuptools is installed,
74 this routine will print a message to ``sys.stderr`` and raise SystemExit in
75 an attempt to abort the calling script.
79 if setuptools
.__version
__ == '0.0.1':
81 "You have an obsolete version of setuptools installed. Please\n"
82 "remove it from your system entirely before rerunning this script."
86 egg
= download_setuptools(version
, download_base
, to_dir
, download_delay
)
87 sys
.path
.insert(0, egg
)
88 import setuptools
; setuptools
.bootstrap_install_from
= egg
94 pkg_resources
.require("setuptools>="+min_version
)
96 except pkg_resources
.VersionConflict
, e
:
97 # XXX could we install in a subprocess here?
99 "The required version of setuptools (>=%s) is not available, and\n"
100 "can't be installed while this script is running. Please install\n"
101 " a more recent version first.\n\n(Currently using %r)"
102 ) % (min_version
, e
.args
[0])
105 def download_setuptools(
106 version
=DEFAULT_VERSION
, download_base
=DEFAULT_URL
, to_dir
=os
.curdir
,
109 """Download setuptools from a specified location and return its filename
111 `version` should be a valid setuptools version number that is available
112 as an egg for download under the `download_base` URL (which should end
113 with a '/'). `to_dir` is the directory where the egg will be downloaded.
114 `delay` is the number of seconds to pause before an actual download attempt.
116 import urllib2
, shutil
117 egg_name
= "setuptools-%s-py%s.egg" % (version
,sys
.version
[:3])
118 url
= download_base
+ egg_name
119 saveto
= os
.path
.join(to_dir
, egg_name
)
121 if not os
.path
.exists(saveto
): # Avoid repeated downloads
123 from distutils
import log
126 ---------------------------------------------------------------------------
127 This script requires setuptools version %s to run (even to display
128 help). I will attempt to download it for you (from
130 you may need to enable firewall access for this script first.
131 I will start the download in %d seconds.
133 (Note: if this machine does not have network access, please obtain the file
137 and place it in this directory before rerunning this script.)
138 ---------------------------------------------------------------------------""",
139 version
, download_base
, delay
, url
140 ); from time
import sleep
; sleep(delay
)
141 log
.warn("Downloading %s", url
)
142 src
= urllib2
.urlopen(url
)
143 # Read/write all in one block, so we don't create a corrupt file
144 # if the download is interrupted.
145 data
= _validate_md5(egg_name
, src
.read())
146 dst
= open(saveto
,"wb"); dst
.write(data
)
150 return os
.path
.realpath(saveto
)
152 def main(argv
, version
=DEFAULT_VERSION
):
153 """Install or upgrade setuptools and EasyInstall"""
160 egg
= download_setuptools(version
, delay
=0)
161 sys
.path
.insert(0,egg
)
162 from setuptools
.command
.easy_install
import main
163 return main(list(argv
)+[egg
]) # we're done here
165 if egg
and os
.path
.exists(egg
):
168 if setuptools
.__version
__ == '0.0.1':
169 # tell the user to uninstall obsolete version
170 use_setuptools(version
)
172 req
= "setuptools>="+version
175 pkg_resources
.require(req
)
176 except pkg_resources
.VersionConflict
:
178 from setuptools
.command
.easy_install
import main
180 from easy_install
import main
181 main(list(argv
)+[download_setuptools(delay
=0)])
182 sys
.exit(0) # try to force an exit
185 from setuptools
.command
.easy_install
import main
188 print "Setuptools version",version
,"or greater has been installed."
189 print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)'
193 def update_md5(filenames
):
194 """Update our built-in md5 registry"""
199 for name
in filenames
:
200 base
= os
.path
.basename(name
)
202 md5_data
[base
] = md5(f
.read()).hexdigest()
205 data
= [" %r: %r,\n" % it
for it
in md5_data
.items()]
210 srcfile
= inspect
.getsourcefile(sys
.modules
[__name__
])
211 f
= open(srcfile
, 'rb'); src
= f
.read(); f
.close()
213 match
= re
.search("\nmd5_data = {\n([^}]+)}", src
)
215 print >>sys
.stderr
, "Internal error!"
218 src
= src
[:match
.start(1)] + repl
+ src
[match
.end(1):]
219 f
= open(srcfile
,'w')
224 if __name__
=='__main__':
225 if len(sys
.argv
)>2 and sys
.argv
[1]=='--md5update':
226 update_md5(sys
.argv
[2:])