aboutsummaryrefslogtreecommitdiffstats
path: root/docs/setuptools.txt
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2019-10-27 18:26:30 -0400
committerGitHub <noreply@github.com>2019-10-27 18:26:30 -0400
commiteccd31805b2d1ffb22478fa37c88760ad4db1387 (patch)
tree2dfa002a7b0e8a982177dc48655aceeefb0f5711 /docs/setuptools.txt
parent0c9d7a70c5011a75188445319feb73f26c5623f4 (diff)
parentb5a9209cd2a3882204e0f9c9158a4a4d1ebf5e9b (diff)
downloadexternal_python_setuptools-eccd31805b2d1ffb22478fa37c88760ad4db1387.tar.gz
external_python_setuptools-eccd31805b2d1ffb22478fa37c88760ad4db1387.tar.bz2
external_python_setuptools-eccd31805b2d1ffb22478fa37c88760ad4db1387.zip
Merge pull request #1862 from benoit-pierre/drop-ez_setup-documentation
docs: drop ez_setup documentation and related references
Diffstat (limited to 'docs/setuptools.txt')
-rw-r--r--docs/setuptools.txt29
1 files changed, 1 insertions, 28 deletions
diff --git a/docs/setuptools.txt b/docs/setuptools.txt
index b3852232..3c6243e2 100644
--- a/docs/setuptools.txt
+++ b/docs/setuptools.txt
@@ -8,14 +8,7 @@ distribute Python packages, especially ones that have dependencies on other
packages.
Packages built and distributed using ``setuptools`` look to the user like
-ordinary Python packages based on the ``distutils``. Your users don't need to
-install or even know about setuptools in order to use them, and you don't
-have to include the entire setuptools package in your distributions. By
-including just a single `bootstrap module`_ (a 12K .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: https://bootstrap.pypa.io/ez_setup.py
+ordinary Python packages based on the ``distutils``.
Feature Highlights:
@@ -56,8 +49,6 @@ Feature Highlights:
.. contents:: **Table of Contents**
-.. _ez_setup.py: `bootstrap module`_
-
-----------------
Developer's Guide
@@ -590,10 +581,6 @@ 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 ez_setup the installation of
-setuptools itself on non-Windows platforms, but may also be useful for other
-projects as well.
-
IMPORTANT NOTE: Eggs with an "eggsecutable" header cannot be renamed, or
invoked via symlinks. They *must* be invoked using their original filename, in
order to ensure that, once running, ``pkg_resources`` will know what project
@@ -1254,20 +1241,6 @@ To install your newly uploaded package ``example_pkg``, you can use pip::
If you have issues at any point, please refer to `Packaging project tutorials`_
for clarification.
-Distributing legacy ``setuptools`` projects using ez_setup.py
--------------------------------------------------------------
-
-.. warning:: **ez_setup** is deprecated in favor of PIP with **PEP-518** support.
-
-Distributing packages using the legacy ``ez_setup.py`` and ``easy_install`` is
-deprecated in favor of PIP. Please consider migrating to using pip and twine based
-distribution.
-
-However, if you still have any ``ez_setup`` based packages, documentation for
-ez_setup based distributions can be found at `ez_setup distribution guide`_.
-
-.. _ez_setup distribution guide: ez_setup.html
-
Setting the ``zip_safe`` flag
-----------------------------