setuptools-0.6c16dev4.egg/zetuptoolz.txt

   1 This is the "zetuptoolz" fork of setuptools. This version is forked from
   2 setuptools trunk r80621 (which is current as of 2010-08-31), with the following
   3 differences:
   4
   5
   6  * Zooko's and David-Sarah's patches for the following bugs and features have been applied:
   7
   8      <http://bugs.python.org/setuptools/issue17>
   9      "easy_install will install a package that is already there"
  10
  11      <http://bugs.python.org/setuptools/issue54>
  12      "be more like distutils with regard to --prefix="
  13
  14      <http://bugs.python.org/setuptools/issue53>
  15      "respect the PYTHONPATH"
  16      (Note: this patch does not work as intended when site.py has been modified.
  17      This will be fixed in a future version.)
  18
  19      <https://tahoe-lafs.org/trac/zetuptoolz/ticket/4>
  20      "python setup.py --help-commands raises exception due to conflict with distribute"
  21
  22
  23  * The following patch to setuptools introduced bugs, and has been reverted
  24    in zetuptoolz:
  25
  26     $ svn log -r 45514
  27     ------------------------------------------------------------------------
  28     r45514 | phillip.eby | 2006-04-18 04:03:16 +0100 (Tue, 18 Apr 2006) | 9 lines
  29
  30     Backport pkgutil, pydoc, and doctest from the 2.5 trunk to setuptools
  31     0.7 trunk.  (Sideport?)  Setuptools 0.7 will install these in place of
  32     the 2.3/2.4 versions (at least of pydoc and doctest) to let them work
  33     properly with eggs.  pkg_resources now depends on the 2.5 pkgutil, which
  34     is included here as _pkgutil, to work around the fact that some system
  35     packagers will install setuptools without overriding the stdlib modules.
  36     But users who install their own setuptools will get them, and the system
  37     packaged people probably don't need them.
  38     ------------------------------------------------------------------------
  39
  40
  41  * If unpatched setuptools decides that it needs to change an existing site.py
  42    file that appears not to have been written by it (because the file does not
  43    start with "def __boot():"), it aborts the installation.
  44    zetuptoolz leaves the file alone and outputs a warning, but continues with
  45    the installation.
  46
  47
  48  * The scripts written by zetuptoolz have the following extra line:
  49
  50      # generated by zetuptoolz <version number>
  51
  52    after the header.
  53
  54
  55  * Windows-specific changes (native Python):
  56
  57    Python distributions may have command-line or GUI scripts.
  58    On Windows, setuptools creates an executable wrapper to run each
  59    script. zetuptools uses a different approach that does not require
  60    an .exe wrapper. It writes approximately the same script file that
  61    is used on other platforms, but with a .pyscript extension.
  62    It also writes a shell-script wrapper (without any extension) that
  63    is only used when the command is run from a Cygwin shell.
  64
  65    Some of the advantages of this approach are:
  66
  67     * Unicode arguments are preserved (although the program will
  68       need to use some Windows-specific code to get at them in
  69       current versions of Python);
  70     * it works correctly on 64-bit Windows;
  71     * the zetuptoolz distribution need not contain either any
  72       binary executables, or any C code that needs to be compiled.
  73
  74    See setuptools\tests\win_script_wrapper.txt for further details.
  75
  76    Installing or building any distribution on Windows will automatically
  77    associate .pyscript with the native Python interpreter for the current
  78    user. It will also add .pyscript and .pyw to the PATHEXT variable for
  79    the current user, which is needed to allow scripts to be run without
  80    typing any extension.
  81
  82    There is an additional setup.py command that can be used to perform
  83    these steps separately (which isn't normally needed, but might be
  84    useful for debugging):
  85
  86      python setup.py scriptsetup
  87
  88    Adding the --allusers option, i.e.
  89
  90      python setup.py scriptsetup --allusers
  91
  92    will make the .pyscript association and changes to the PATHEXT variable
  93    for all users of this Windows installation, except those that have it
  94    overridden in their per-user environment. In this case setup.py must be
  95    run with Administrator privileges, e.g. from a Command Prompt whose
  96    shortcut has been set to run as Administrator.