[Python-checkins] python/nondist/sandbox/setuptools EasyInstall.txt, 1.52, 1.53 ez_setup.py, 1.23, 1.24 pkg_resources.txt, 1.11, 1.12 setuptools.txt, 1.31, 1.32
pje@users.sourceforge.net
pje at users.sourceforge.net
Mon Aug 22 05:28:38 CEST 2005
Update of /cvsroot/python/python/nondist/sandbox/setuptools
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv6451
Modified Files:
EasyInstall.txt ez_setup.py pkg_resources.txt setuptools.txt
Log Message:
More documentation enhancements.
Index: EasyInstall.txt
===================================================================
RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/EasyInstall.txt,v
retrieving revision 1.52
retrieving revision 1.53
diff -u -d -r1.52 -r1.53
--- EasyInstall.txt 22 Aug 2005 03:14:58 -0000 1.52
+++ EasyInstall.txt 22 Aug 2005 03:28:27 -0000 1.53
@@ -28,11 +28,19 @@
Installing "Easy Install"
-------------------------
+If you are behind an NTLM-based firewall that prevents Python programs from
+accessing the net directly, you may wish to first install and use the `APS
+proxy server <http://ntlmaps.sf.net/>`_, which lets you get past such firewalls
+in the same way that your web browser(s) do.
+
+If you do not have write access to your computer's ``site-packages`` directory,
+please also see the section below on `Non-Root Installation`_ for more detailed
+instructions on pre-configuring your system for the best usability with
+EasyInstall, then return here for the remaining steps.
+
Download `ez_setup.py <http://peak.telecommunity.com/dist/ez_setup.py>`_, and
run it; this will download and install the appropriate ``setuptools`` egg for
-your Python version. (Note: if you do not have write access to your computer's
-``site-packages`` directory, please see the section below on `Non-Root
-Installation`_ for more detailed instructions.)
+your Python version.
You may receive a message telling you about an obsolete version of
setuptools being present; if so, you must be sure to delete it entirely, along
Index: ez_setup.py
===================================================================
RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/ez_setup.py,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -d -r1.23 -r1.24
--- ez_setup.py 22 Aug 2005 00:35:47 -0000 1.23
+++ ez_setup.py 22 Aug 2005 03:28:27 -0000 1.24
@@ -109,8 +109,7 @@
I will start the download in %d seconds.
---------------------------------------------------------------------------""",
version, download_base, delay
- )
- from time import sleep; sleep(delay)
+ ); from time import sleep; sleep(delay)
log.warn("Downloading %s", url)
src = urllib2.urlopen(url)
# Read/write all in one block, so we don't create a corrupt file
Index: pkg_resources.txt
===================================================================
RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/pkg_resources.txt,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -d -r1.11 -r1.12
--- pkg_resources.txt 21 Aug 2005 22:12:12 -0000 1.11
+++ pkg_resources.txt 22 Aug 2005 03:28:27 -0000 1.12
@@ -18,7 +18,8 @@
Overview
--------
-XXX TBD
+This section isn't written yet. For now, please check out the extensive `API
+Reference`_ below.
-----------------
@@ -43,6 +44,8 @@
Extended Discovery and Installation
Supporting Custom PEP 302 Implementations
+For now, please check out the extensive `API Reference`_ below.
+
-------------
API Reference
Index: setuptools.txt
===================================================================
RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/setuptools.txt,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -d -r1.31 -r1.32
--- setuptools.txt 14 Aug 2005 01:45:37 -0000 1.31
+++ setuptools.txt 22 Aug 2005 03:28:27 -0000 1.32
@@ -69,12 +69,21 @@
Installing ``setuptools``
=========================
-Download `ez_setup.py`_ and run it; this will download and install the
-appropriate egg for your Python version. (Note: if you are behind
-an NTLM-based firewall that prevents Python programs from accessing the net
-directly, you may wish to install and use the `APS proxy server
-<http://ntlmaps.sf.net/>`_, which lets you get past such firewalls in the same
-way that your web browser(s) do.)
+If you are behind an NTLM-based firewall that prevents Python programs from
+accessing the net directly, you may wish to first install and use the `APS
+proxy server <http://ntlmaps.sf.net/>`_, which lets you get past such firewalls
+in the same way that your web browser(s) do.
+
+If you do not have write access to your computer's ``site-packages`` directory,
+please also see the EasyInstall documentation on `Non-Root Installation`_ for
+more detailed instructions on pre-configuring your system for the best
+usability with setuptools and EasyInstall, then return here for the remaining
+steps.
+
+.. _Non-Root Installation: http://peak.telecommunity.com/DevCenter/EasyInstall#non-root-installation
+
+To install setuptools, first download `ez_setup.py`_ and run it; this will
+automatically download and install the appropriate egg for your Python version.
.. _ez_setup.py: `bootstrap module`_
@@ -90,15 +99,18 @@
You can then install it using the usual "setup.py install" incantation.
-Note that ``setuptools`` *must* be installed as an egg directory; it will not
+(Note that ``setuptools`` *must* be installed as an egg directory; it will not
operate correctly otherwise. If you are unable to install to a valid
-``site-packages`` directory (e.g. a "non-root install"), you will therefore
-need to manually add the setuptools egg to your ``PYTHONPATH``. (You won't
-need to do this for every egg you install, because the ``pkg_resources`` module
-can automatically find eggs and add them to ``sys.path`` at runtime. It's just
-that the ``setuptools`` egg contains ``pkg_resources`` and therefore has to
-be manually bootstrapped if you can't install it to a ``site-packages``
-directory.)
+``site-packages`` directory (e.g. a "non-root install" that doesn't conform
+to the `Non-Root Installation`_ procedure), you will therefore need to manually
+add the setuptools egg to your ``PYTHONPATH``. You won't need to do this for
+every egg you install, because the ``pkg_resources`` module can automatically
+find eggs and add them to ``sys.path`` at runtime. It's just that the
+``setuptools`` egg contains the ``pkg_resources`` runtime, and therefore has to
+be manually bootstrapped if you can't install it to a valid ``site-packages``
+directory. However, if you are installing as root or you followed the
+`Non-Root Installation`_ procedure, you shouldn't have to worry about any of
+this.)
Basic Use
More information about the Python-checkins
mailing list