diff options
| -rw-r--r-- | bootstrapping.py | 4 | ||||
| -rw-r--r-- | docs/easy_install.txt | 11 | ||||
| -rw-r--r-- | docs/setuptools.txt | 47 | ||||
| -rw-r--r-- | pkg_resources.py | 2 | ||||
| -rw-r--r-- | setuptools/__init__.py | 4 | ||||
| -rwxr-xr-x | virtual-python.py | 4 |
6 files changed, 37 insertions, 35 deletions
diff --git a/bootstrapping.py b/bootstrapping.py index aed90bd0..f7e2045e 100644 --- a/bootstrapping.py +++ b/bootstrapping.py @@ -4,7 +4,7 @@ If you want to use setuptools in your package's setup.py, just include this file in the same directory with it, and add this to the top of your setup.py:: - from ez_setup import use_setuptools + from bootstrapping import use_setuptools use_setuptools() If you want to require a specific version of setuptools, set a download @@ -391,7 +391,7 @@ def main(argv, version=DEFAULT_VERSION): #main(argv) else: print "distribute version",version,"or greater has been installed." - print '(Run "ez_setup.py -U distribute" to reinstall or upgrade.)' + print '(Run "bootstrapping.py -U distribute" to reinstall or upgrade.)' def update_md5(filenames): """Update our built-in md5 registry""" diff --git a/docs/easy_install.txt b/docs/easy_install.txt index e3b569e2..4461ad31 100644 --- a/docs/easy_install.txt +++ b/docs/easy_install.txt @@ -93,8 +93,8 @@ Note that instead of changing your ``PATH`` to include the Python scripts directory, you can also retarget the installation location for scripts so they go on a directory that's already on the ``PATH``. For more information see the sections below on `Command-Line Options`_ and `Configuration Files`_. You -can pass command line options (such as ``--script-dir``) to ``ez_setup.py`` to -control where ``easy_install.exe`` will be installed. +can pass command line options (such as ``--script-dir``) to +``bootstrapping.py`` to control where ``easy_install.exe`` will be installed. @@ -1111,9 +1111,10 @@ already have them:: install_lib = ~/py-lib install_scripts = ~/bin -Be sure to do this *before* you try to run the ``ez_setup.py`` installation -script. Then, follow the standard `installation instructions`_, but make -sure that ``~/py-lib`` is listed in your ``PYTHONPATH`` environment variable. +Be sure to do this *before* you try to run the ``bootstrapping.py`` +installation script. Then, follow the standard `installation instructions`_, +but make sure that ``~/py-lib`` is listed in your ``PYTHONPATH`` environment +variable. Your library installation directory *must* be in listed in ``PYTHONPATH``, not only when you install packages with EasyInstall, but also when you use 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 diff --git a/pkg_resources.py b/pkg_resources.py index 92fef2c0..c636903c 100644 --- a/pkg_resources.py +++ b/pkg_resources.py @@ -30,7 +30,7 @@ from os.path import isdir, split # or by the Distribute project, in case Setuptools creates # a distribution with the same version. # -# The ez_setup script for instance, will check if this +# The bootstrapping script for instance, will check if this # attribute is present to decide wether to reinstall the package _distribute = True diff --git a/setuptools/__init__.py b/setuptools/__init__.py index f911ef8f..58e46d4f 100644 --- a/setuptools/__init__.py +++ b/setuptools/__init__.py @@ -18,7 +18,7 @@ __all__ = [ # or by the Distribute project, in case Setuptools creates # a distribution with the same version. # -# The ez_setup script for instance, will check if this +# The bootstrapping script for instance, will check if this # attribute is present to decide wether to reinstall the package _distribute = True @@ -43,7 +43,7 @@ def find_packages(where='.', exclude=()): os.path.isfile(os.path.join(fn,'__init__.py')) ): out.append(prefix+name); stack.append((fn,prefix+name+'.')) - for pat in list(exclude)+['ez_setup']: + for pat in list(exclude)+['ez_setup', 'bootstrapping']: from fnmatch import fnmatchcase out = [item for item in out if not fnmatchcase(item,pat)] return out diff --git a/virtual-python.py b/virtual-python.py index 8624f37d..8d705588 100755 --- a/virtual-python.py +++ b/virtual-python.py @@ -115,8 +115,8 @@ def main(): print 'Please make sure you remove any previous custom paths from' print "your", pydistutils, "file." - print "You're now ready to download ez_setup.py, and run" - print py_executable, "ez_setup.py" + print "You're now ready to download bootstrapping.py, and run" + print py_executable, "bootstrapping.py" if __name__ == '__main__': main() |