Skip to content

Commit 2e5d59e

Browse files
committed
Add notes to changelog and docs for installing on Python < 3.8
1 parent d95c205 commit 2e5d59e

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

CHANGES.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@
1616
- On Python 3.8 and later, ``setuptools`` is no longer a runtime
1717
dependency. Patch by Ofek Lev.
1818

19+
- On Python versions before 3.8, ``setuptools`` is still a runtime
20+
dependency (for ``pkg_resources``) but it is no longer declared in
21+
``setup.py`` as such. This is because adding a conditional dependency
22+
with an environment marker (``setuptools; python_version < '3.8'``)
23+
breaks installation in some scenarios, e.g. ``setup.py install`` or
24+
older versions of ``pip``. Ensure that ``setuptools`` in installed
25+
if using Python before 3.8.
26+
1927
- ``supervisorctl`` now reads extra files included via the ``[include]``
2028
section in ``supervisord.conf`` like ``supervisord`` does. This allows
2129
the ``[supervisorctl]`` section or ``[ctlplugin:x]`` sections to be in

docs/installing.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ to be the root user to install Supervisor successfully using
2222

2323
You can also install supervisor in a virtualenv via ``pip``.
2424

25+
.. note::
26+
27+
If installing on a Python version before 3.8, first ensure that the
28+
``setuptools`` package is installed because it is a runtime
29+
dependency of Supervisor.
30+
2531
Internet-Installing Without Pip
2632
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2733

@@ -39,6 +45,12 @@ finally install Supervisor itself.
3945
need to be the root user to successfully invoke ``python
4046
setup.py install``.
4147

48+
.. note::
49+
50+
The ``setuptools`` package is required to run ``python setup.py install``.
51+
On Python versions before 3.8, ``setuptools`` is also a runtime
52+
dependency of Supervisor.
53+
4254
Installing To A System Without Internet Access
4355
----------------------------------------------
4456

@@ -63,6 +75,12 @@ Finally, run supervisor's ``python setup.py install``.
6375
need to be the root user to invoke ``python setup.py install``
6476
successfully for each package.
6577

78+
.. note::
79+
80+
The ``setuptools`` package is required to run ``python setup.py install``.
81+
On Python versions before 3.8, ``setuptools`` is also a runtime
82+
dependency of Supervisor.
83+
6684
Installing a Distribution Package
6785
---------------------------------
6886

0 commit comments

Comments
 (0)