aboutsummaryrefslogtreecommitdiffstats
path: root/docs/setuptools.txt
diff options
context:
space:
mode:
authortarek <none@none>2009-08-08 21:10:11 +0200
committertarek <none@none>2009-08-08 21:10:11 +0200
commit96f2536dcc1056dffa72f0877f1683b6633440f0 (patch)
tree19b9e79451aca738677aa72cf67a444a97be61c6 /docs/setuptools.txt
parentdef1a4f577242d326a93268c2851e2b3f48c5329 (diff)
downloadexternal_python_setuptools-96f2536dcc1056dffa72f0877f1683b6633440f0.tar.gz
external_python_setuptools-96f2536dcc1056dffa72f0877f1683b6633440f0.tar.bz2
external_python_setuptools-96f2536dcc1056dffa72f0877f1683b6633440f0.zip
bootstrapping.py -> distribute_setup.py
--HG-- branch : distribute extra : rebase_source : 4e57a0bc1a8bea73bc8ed0f102d0e0907c554235
Diffstat (limited to 'docs/setuptools.txt')
-rw-r--r--docs/setuptools.txt36
1 files changed, 18 insertions, 18 deletions
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index 79a17006..bc51df2d 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/bootstrapping.py
+.. _bootstrap module: http://cdn.bitbucket.org/tarek/distribute/downloads/distribute_setup.py
Feature Highlights:
@@ -72,7 +72,7 @@ is available from the `Python SVN sandbox`_, and in-development versions of the
.. contents:: **Table of Contents**
-.. _bootstrapping.py: `bootstrap module`_
+.. _distribute_setup.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::
- bootstrapping.py setuptools==dev
+ distribute_setup.py setuptools==dev
This will download and install the latest development (i.e. unstable) version
of setuptools from the Python Subversion sandbox.
@@ -523,7 +523,7 @@ Python must be available via the ``PATH`` environment variable, under its
"long" name. That is, if the egg is built for Python 2.3, there must be a
``python2.3`` executable present in a directory on ``PATH``.
-This feature is primarily intended to support bootstrapping the installation of
+This feature is primarily intended to support distribute_setup the installation of
setuptools itself on non-Windows platforms, but may also be useful for other
projects as well.
@@ -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 `bootstrapping.py`_, and put it in the same directory as your ``setup.py``
+download `distribute_setup.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 bootstrapping
- bootstrapping.use_setuptools()
+ import distribute_setup
+ distribute_setup.use_setuptools()
-That's it. The ``bootstrapping`` module will automatically download a matching
+That's it. The ``distribute_setup`` 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' ``bootstrapping.py`` files, so that a matching version gets installed
+your projects' ``distribute_setup.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,7 +1143,7 @@ relevant to your project and your target audience isn't already familiar with
setuptools and ``easy_install``.
Network Access
- If your project is using ``bootstrapping``, you should inform users of the
+ If your project is using ``distribute_setup``, 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
@@ -1223,27 +1223,27 @@ Creating System Packages
Managing Multiple Projects
--------------------------
-If you're managing several projects that need to use ``bootstrapping``, and you
+If you're managing several projects that need to use ``distribute_setup``, 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
+"svn:externals" property to share a single copy of ``distribute_setup`` 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 ``bootstrapping.py`` into ``bootstrapping/__init__.py`` in order
-to do this, then create "externals" definitions that map the ``bootstrapping``
+have to turn ``distribute_setup.py`` into ``distribute_setup/__init__.py`` in order
+to do this, then create "externals" definitions that map the ``distribute_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 ``bootstrapping`` package, to keep it from being included in your
+resulting ``distribute_setup`` package, to keep it from being included in your
distributions, e.g.::
setup(
...
- packages = find_packages(exclude=['bootstrapping']),
+ packages = find_packages(exclude=['distribute_setup']),
)
-Of course, the ``bootstrapping`` package will still be included in your
+Of course, the ``distribute_setup`` 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
@@ -2584,7 +2584,7 @@ XXX
Reusing ``setuptools`` Code
===========================
-``bootstrapping``
+``distribute_setup``
-----------------
XXX