aboutsummaryrefslogtreecommitdiffstats
path: root/docs/setuptools.txt
diff options
context:
space:
mode:
authorHanno Schlichting <hanno@hannosch.eu>2009-08-08 12:14:21 +0100
committerHanno Schlichting <hanno@hannosch.eu>2009-08-08 12:14:21 +0100
commitdef1a4f577242d326a93268c2851e2b3f48c5329 (patch)
tree50bd0a0c14826d977700389bc49a0f6bfa284767 /docs/setuptools.txt
parent9fc8f75bc04283b8a724e5245703fe62bdde6528 (diff)
downloadexternal_python_setuptools-def1a4f577242d326a93268c2851e2b3f48c5329.tar.gz
external_python_setuptools-def1a4f577242d326a93268c2851e2b3f48c5329.tar.bz2
external_python_setuptools-def1a4f577242d326a93268c2851e2b3f48c5329.zip
Change references to ez_setup to point to our own bootstrapping instead.
--HG-- branch : distribute extra : rebase_source : 4a2876da3de96acd0cae98f6cc2cdac28ed39846
Diffstat (limited to 'docs/setuptools.txt')
-rw-r--r--docs/setuptools.txt47
1 files changed, 24 insertions, 23 deletions
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index 134c77eb..79a17006 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -15,7 +15,7 @@ including just a single `bootstrap module`_ (an 8K .py file), your package will
automatically download and install ``setuptools`` if the user is building your
package from source and doesn't have a suitable version already installed.
-.. _bootstrap module: http://cdn.bitbucket.org/tarek/distribute/downloads/ez_setup.py
+.. _bootstrap module: http://cdn.bitbucket.org/tarek/distribute/downloads/bootstrapping.py
Feature Highlights:
@@ -72,7 +72,7 @@ is available from the `Python SVN sandbox`_, and in-development versions of the
.. contents:: **Table of Contents**
-.. _ez_setup.py: `bootstrap module`_
+.. _bootstrapping.py: `bootstrap module`_
-----------------
@@ -95,7 +95,7 @@ other than Python's ``site-packages`` directory.
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
+ bootstrapping.py setuptools==dev
This will download and install the latest development (i.e. unstable) version
of setuptools from the Python Subversion sandbox.
@@ -1102,18 +1102,18 @@ Using ``setuptools``... Without bundling it!
Your users might not have ``setuptools`` installed on their machines, or even
if they do, it might not be the right version. Fixing this is easy; just
-download `ez_setup.py`_, and put it in the same directory as your ``setup.py``
+download `bootstrapping.py`_, and put it in the same directory as your ``setup.py``
script. (Be sure to add it to your revision control system, too.) Then add
these two lines to the very top of your setup script, before the script imports
anything from setuptools::
- import ez_setup
- ez_setup.use_setuptools()
+ import bootstrapping
+ bootstrapping.use_setuptools()
-That's it. The ``ez_setup`` module will automatically download a matching
+That's it. The ``bootstrapping`` module will automatically download a matching
version of ``setuptools`` from PyPI, if it isn't present on the target system.
Whenever you install an updated version of setuptools, you should also update
-your projects' ``ez_setup.py`` files, so that a matching version gets installed
+your projects' ``bootstrapping.py`` files, so that a matching version gets installed
on the target machine(s).
By the way, setuptools supports the new PyPI "upload" command, so you can use
@@ -1143,8 +1143,8 @@ relevant to your project and your target audience isn't already familiar with
setuptools and ``easy_install``.
Network Access
- If your project is using ``ez_setup``, you should inform users of the need
- to either have network access, or to preinstall the correct version of
+ If your project is using ``bootstrapping``, you should inform users of the
+ need to either have network access, or to preinstall the correct version of
setuptools using the `EasyInstall installation instructions`_. Those
instructions also have tips for dealing with firewalls as well as how to
manually download and install setuptools.
@@ -1223,27 +1223,28 @@ Creating System Packages
Managing Multiple Projects
--------------------------
-If you're managing several projects that need to use ``ez_setup``, and you are
-using Subversion as your revision control system, you can use the
-"svn:externals" property to share a single copy of ``ez_setup`` between
+If you're managing several projects that need to use ``bootstrapping``, and you
+are using Subversion as your revision control system, you can use the
+"svn:externals" property to share a single copy of ``bootstrapping`` between
projects, so that it will always be up-to-date whenever you check out or update
an individual project, without having to manually update each project to use
a new version.
However, because Subversion only supports using directories as externals, you
-have to turn ``ez_setup.py`` into ``ez_setup/__init__.py`` in order to do this,
-then create "externals" definitions that map the ``ez_setup`` directory into
-each project. Also, if any of your projects use ``find_packages()`` on their
-setup directory, you will need to exclude the resulting ``ez_setup`` package,
-to keep it from being included in your distributions, e.g.::
+have to turn ``bootstrapping.py`` into ``bootstrapping/__init__.py`` in order
+to do this, then create "externals" definitions that map the ``bootstrapping``
+directory into each project. Also, if any of your projects use
+``find_packages()`` on their setup directory, you will need to exclude the
+resulting ``bootstrapping`` package, to keep it from being included in your
+distributions, e.g.::
setup(
...
- packages = find_packages(exclude=['ez_setup']),
+ packages = find_packages(exclude=['bootstrapping']),
)
-Of course, the ``ez_setup`` package will still be included in your packages'
-source distributions, as it needs to be.
+Of course, the ``bootstrapping`` package will still be included in your
+packages' source distributions, as it needs to be.
For your convenience, you may use the following external definition, which will
track the latest version of setuptools::
@@ -2583,8 +2584,8 @@ XXX
Reusing ``setuptools`` Code
===========================
-``ez_setup``
-------------
+``bootstrapping``
+-----------------
XXX