Skip to content

Commit 96f0781

Browse files
committed
Wrap lines and remove newlines between enumerated paragraphs.
1 parent e0b3acb commit 96f0781

File tree

1 file changed

+51
-17
lines changed

1 file changed

+51
-17
lines changed

docs/python 2 sunset.txt

+51-17
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,67 @@
33
Python 2 Sunset
44
===============
55

6-
Since January 2020 and the release of Setuptools 45, Python 2 is no longer supported by the most current release (`discussion <https://github.com/pypa/setuptools/issues/1458>`_). Setuptools as a project continues to support Python 2 with bugfixes and important features on Setuptools 44.x.
6+
Since January 2020 and the release of Setuptools 45, Python 2 is no longer
7+
supported by the most current release (`discussion
8+
<https://github.com/pypa/setuptools/issues/1458>`_). Setuptools as a project
9+
continues to support Python 2 with bugfixes and important features on
10+
Setuptools 44.x.
711

8-
By design, most users will be unaffected by this change. That's because Setuptools 45 declares its supported Python versions to exclude Python 2.7, and installers such as pip 9 or later will honor this declaration and prevent installation of Setuptools 45 or later in Python 2 environments.
12+
By design, most users will be unaffected by this change. That's because
13+
Setuptools 45 declares its supported Python versions to exclude Python 2.7,
14+
and installers such as pip 9 or later will honor this declaration and prevent
15+
installation of Setuptools 45 or later in Python 2 environments.
916

10-
Users that do import any portion of Setuptools 45 or later on Python 2 are directed to this documentation to provide guidance on how to work around the issues.
17+
Users that do import any portion of Setuptools 45 or later on Python 2 are
18+
directed to this documentation to provide guidance on how to work around the
19+
issues.
1120

1221
Workarounds
1322
-----------
1423

15-
The best recommendation is to avoid Python 2 and move to Python 3 where possible. This project acknowledges that not all environments can drop Python 2 support, so provides other options.
24+
The best recommendation is to avoid Python 2 and move to Python 3 where
25+
possible. This project acknowledges that not all environments can drop Python
26+
2 support, so provides other options.
1627

17-
In less common scenarios, later versions of Setuptools can be installed on unsupported Python versions. In these environments, the installer is advised to first install ``setuptools<45`` to "pin Setuptools" to a compatible version.
28+
In less common scenarios, later versions of Setuptools can be installed on
29+
unsupported Python versions. In these environments, the installer is advised
30+
to first install ``setuptools<45`` to "pin Setuptools" to a compatible
31+
version.
1832

19-
- When using older versions of pip (before 9.0), the ``Requires-Python`` directive is not honored and invalid versions can be installed. Users are advised first to upgrade pip and retry or to pin Setuptools. Use ``pip --version`` to determine the version of pip.
20-
- When using ``easy_install``, ``Requires-Python`` is not honored and later versions can be installed. In this case, users are advised to pin Setuptools. This applies to ``setup.py install`` invocations as well, as they use Setuptools under the hood.
33+
- When using older versions of pip (before 9.0), the ``Requires-Python``
34+
directive is not honored and invalid versions can be installed. Users are
35+
advised first to upgrade pip and retry or to pin Setuptools. Use ``pip
36+
--version`` to determine the version of pip.
37+
- When using ``easy_install``, ``Requires-Python`` is not honored and later
38+
versions can be installed. In this case, users are advised to pin
39+
Setuptools. This applies to ``setup.py install`` invocations as well, as
40+
they use Setuptools under the hood.
2141

2242
It's still not working
2343
----------------------
2444

25-
If after trying the above steps, the Python environment still has incompatible versions of Setuptools installed, here are some things to try.
45+
If after trying the above steps, the Python environment still has incompatible
46+
versions of Setuptools installed, here are some things to try.
2647

27-
1. Uninstall and reinstall Setuptools. Run ``pip uninstall -y setuptools`` for the relevant environment. Repeat until there is no Setuptools installed. Then ``pip install setuptools``.
28-
29-
2. If possible, attempt to replicate the problem in a second environment (virtual machine, friend's computer, etc). If the issue is isolated to just one unique enviornment, first determine what is different about those environments (or reinstall/reset the failing one to defaults).
30-
31-
3. End users who are not themselves the maintainers for the package they are trying to install should contact the support channels for the relevant application. Please be respectful by searching for existing issues and following the latest guidance before reaching out for support. When filing an issue, be sure to give as much detail as possible to help the maintainers understand what factors led to the issue after following their recommended guidance.
32-
33-
4. Reach out to your local support groups. There's a good chance someone nearby has the expertise and willingness to help.
34-
35-
5. If all else fails, `file this template <https://github.com/pypa/setuptools/issues/new?assignees=&labels=Python+2&template=setuptools-warns-about-python-2-incompatibility.md&title=Incompatible+install+in+(summarize+your+environment)>`_ with Setuptools. Please complete the whole template, providing as much detail about what factors led to the issue. Setuptools maintainers will summarily close tickets filed without any meaningful detail or engagement with the issue.
48+
1. Uninstall and reinstall Setuptools. Run ``pip uninstall -y setuptools`` for
49+
the relevant environment. Repeat until there is no Setuptools installed.
50+
Then ``pip install setuptools``.
51+
2. If possible, attempt to replicate the problem in a second environment
52+
(virtual machine, friend's computer, etc). If the issue is isolated to just
53+
one unique enviornment, first determine what is different about those
54+
environments (or reinstall/reset the failing one to defaults).
55+
3. End users who are not themselves the maintainers for the package they are
56+
trying to install should contact the support channels for the relevant
57+
application. Please be respectful by searching for existing issues and
58+
following the latest guidance before reaching out for support. When filing
59+
an issue, be sure to give as much detail as possible to help the
60+
maintainers understand what factors led to the issue after following their
61+
recommended guidance.
62+
4. Reach out to your local support groups. There's a good chance someone
63+
nearby has the expertise and willingness to help.
64+
5. If all else fails, `file this template
65+
<https://github.com/pypa/setuptools/issues/new?assignees=&labels=Python+2&template=setuptools-warns-about-python-2-incompatibility.md&title=Incompatible+install+in+(summarize+your+environment)>`_
66+
with Setuptools. Please complete the whole template, providing as much
67+
detail about what factors led to the issue. Setuptools maintainers will
68+
summarily close tickets filed without any meaningful detail or engagement
69+
with the issue.

0 commit comments

Comments
 (0)