Python: discourage direct setup.py install
commit2ddaeb7b090ecec0debbb73bdfb18a0d9080f56d
authorJohn Snow <jsnow@redhat.com>
Mon, 7 Feb 2022 21:30:39 +0000 (7 16:30 -0500)
committerJohn Snow <jsnow@redhat.com>
Wed, 23 Feb 2022 22:07:26 +0000 (23 17:07 -0500)
treec2bd6f9959ce993cef918b09c6d34b0c0821ed4f
parent5c66d7d8de9a00460199669d26cd83fba135bee5
Python: discourage direct setup.py install

When invoking setup.py directly, the default behavior for 'install' is
to run the bdist_egg installation hook, which is ... actually deprecated
by setuptools. It doesn't seem to work quite right anymore.

By contrast, 'pip install' will invoke the bdist_wheel hook
instead. This leads to differences in behavior for the two approaches. I
advocate using pip in the documentation in this directory, but the
'setup.py' which has been used for quite a long time in the Python world
may deceptively appear to work at first glance.

Add an error message that will save a bit of time and frustration
that points the user towards using the supported installation
invocation.

Reported-by: Daniel P. Berrangé <berrange@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Beraldo Leal <bleal@redhat.com>
Message-id: 20220207213039.2278569-1-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>
python/setup.py