Home       Trees       Index       Help   
Package vobject :: Module ez_setup
[show private | hide private]
[frames | no frames]

Module vobject.ez_setup

Bootstrap setuptools installation

If you want to use setuptools in your package's setup.py, just include this file in the same directory with it, and add this to the top of your setup.py: 
   from ez_setup import use_setuptools
   use_setuptools()

If you want to require a specific version of setuptools, set a download mirror, or use an alternate download directory, you can do so by supplying the appropriate options to ``use_setuptools()``.

This file can also be run as a script to install or upgrade setuptools.
Function Summary
  download_setuptools(version, download_base, to_dir, delay)
Download setuptools from a specified location and return its filename
  main(argv, version)
Install or upgrade setuptools and EasyInstall
  update_md5(filenames)
Update our built-in md5 registry
  use_setuptools(version, download_base, to_dir, download_delay)
Automatically find/download setuptools and make it available on sys.path

Variable Summary
str DEFAULT_URL = 'http://cheeseshop.python.org/packages/2.4...
str DEFAULT_VERSION = '0.6c1'
dict md5_data = {'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8...

Function Details

download_setuptools(version='0.6c1', download_base='http://cheeseshop.python.org/packages/2.4/s/setuptools/', to_dir='.', delay=15)

Download setuptools from a specified location and return its filename

`version` should be a valid setuptools version number that is available as an egg for download under the `download_base` URL (which should end with a '/'). `to_dir` is the directory where the egg will be downloaded. `delay` is the number of seconds to pause before an actual download attempt.

main(argv, version='0.6c1')

Install or upgrade setuptools and EasyInstall

update_md5(filenames)

Update our built-in md5 registry

use_setuptools(version='0.6c1', download_base='http://cheeseshop.python.org/packages/2.4/s/setuptools/', to_dir='.', download_delay=15)

Automatically find/download setuptools and make it available on sys.path

`version` should be a valid setuptools version number that is available as an egg for download under the `download_base` URL (which should end with a '/'). `to_dir` is the directory where setuptools will be downloaded, if it is not already available. If `download_delay` is specified, it should be the number of seconds that will be paused before initiating a download, should one be required. If an older version of setuptools is installed, this routine will print a message to ``sys.stderr`` and raise SystemExit in an attempt to abort the calling script.

Variable Details

DEFAULT_URL

Type:
str
Value:
'http://cheeseshop.python.org/packages/2.4/s/setuptools/'

DEFAULT_VERSION

Type:
str
Value:
'0.6c1'

md5_data

Type:
dict
Value:
{'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca',
 'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb',
 'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b',
 'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a',
 'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618',
 'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac',
 'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5',
 'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4',
...

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Fri Dec 14 17:25:14 2007 http://epydoc.sf.net