diff options
author | PJ Eby <distutils-sig@python.org> | 2005-12-16 18:46:56 +0000 |
---|---|---|
committer | PJ Eby <distutils-sig@python.org> | 2005-12-16 18:46:56 +0000 |
commit | 24e257aa80b93f71dac17ad5d336c63d0f515b4c (patch) | |
tree | 5c844023f6102005d84109fa64fe4100700a418b /setuptools.txt | |
parent | d7e72ef75f98a03a74ebeea2d8e105179e3d4dec (diff) | |
download | external_python_setuptools-24e257aa80b93f71dac17ad5d336c63d0f515b4c.tar.gz external_python_setuptools-24e257aa80b93f71dac17ad5d336c63d0f515b4c.tar.bz2 external_python_setuptools-24e257aa80b93f71dac17ad5d336c63d0f515b4c.zip |
Overhaul installation docs to address frequently asked questions
and problems, and to document additional approaches to dealing with
custom install locations. Also, added a note about the parameters
of ``use_setuptools()`` so that persons needing to distribute e.g.
an in-development version of setuptools can do so.
--HG--
branch : setuptools
extra : convert_revision : svn%3A6015fed2-1504-0410-9fe1-9d1591cc4771/sandbox/trunk/setuptools%4041709
Diffstat (limited to 'setuptools.txt')
-rwxr-xr-x | setuptools.txt | 50 |
1 files changed, 14 insertions, 36 deletions
diff --git a/setuptools.txt b/setuptools.txt index 56047527..f68244fa 100755 --- a/setuptools.txt +++ b/setuptools.txt @@ -69,6 +69,8 @@ is available from the `Python SVN sandbox`_. .. contents:: **Table of Contents** +.. _ez_setup.py: `bootstrap module`_ + ----------------- Developer's Guide @@ -78,51 +80,23 @@ Developer's Guide Installing ``setuptools`` ========================= -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 +Please follow the `EasyInstall Installation Instructions`_ to install the +current stable version of setuptools. In particular, be sure to read the +section on `Custom Installation Locations`_ if you are installing anywhere +other than Python's ``site-packages`` directory. -To install setuptools, first download `ez_setup.py`_ and run it; this will -automatically download and install the appropriate egg for your Python version. -(You will need at least Python 2.3.5, or if you are on a 64-bit platform, -Python 2.4.) +.. _EasyInstall Installation Instructions: http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions -.. _ez_setup.py: `bootstrap module`_ - -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 -with the old ``pkg_resources`` module if it's present on ``sys.path``. +.. _Custom Installation Locations: http://peak.telecommunity.com/DevCenter/EasyInstall#custom-installation-locations -To get the in-development version of setuptools, first install a stable version -using the instructions above. Then run:: +If you want the current in-development version of setuptools, you should first +install a stable version, and then run:: ez_setup.py setuptools==dev This will download and install the latest development (i.e. unstable) version of setuptools from the Python Subversion sandbox. -(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" 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 ========= @@ -1018,6 +992,10 @@ bdist_egg upload`` will register the package, build source and egg distributions, and then upload them both to PyPI, where they'll be easily found by other projects that depend on them. +(By the way, if you need to distribute a specific version of ``setuptools``, +you can specify the exact version and base download URL as parameters to the +``use_setuptools()`` function. See the function's docstring for details.) + Managing Multiple Projects -------------------------- |