Skip to content

Commit

Permalink
docs: drop ez_setup documentation and related references
Browse files Browse the repository at this point in the history
  • Loading branch information
benoit-pierre committed Oct 8, 2019
1 parent 734d09c commit b5a9209
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 225 deletions.
1 change: 1 addition & 0 deletions changelog.d/1862.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Drop ez_setup documentation: deprecated for some time (last updated in 2016), and still relying on easy_install (deprecated too).
4 changes: 2 additions & 2 deletions docs/easy_install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -317,8 +317,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
`Command-Line Options`_ and `Configuration Files`_. During installation,
pass command line options (such as ``--script-dir``) to
``ez_setup.py`` to control where ``easy_install.exe`` will be installed.
pass command line options (such as ``--script-dir``) to to control where
scripts will be installed.


Windows Executable Launcher
Expand Down
195 changes: 0 additions & 195 deletions docs/ez_setup.txt

This file was deleted.

29 changes: 1 addition & 28 deletions docs/setuptools.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -62,8 +55,6 @@ Feature Highlights:

.. contents:: **Table of Contents**

.. _ez_setup.py: `bootstrap module`_


-----------------
Developer's Guide
Expand Down Expand Up @@ -596,10 +587,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
Expand Down Expand Up @@ -1263,20 +1250,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
-----------------------------

Expand Down

0 comments on commit b5a9209

Please sign in to comment.