From 5f650853f7908bc04555ea3ee393798502b79fed Mon Sep 17 00:00:00 2001 From: Stephen Finucane <sfinucan@redhat.com> Date: Thu, 22 Oct 2020 09:52:57 +0100 Subject: [PATCH] Remove references to setuptools Newer versions of cliff and stevedore use importlib rather than setuptools to work with entry points. Replace any references to "setuptools' entry points mechanism" with "Python's entry points mechanism". Change-Id: Iae36155685ee37ab5e38a0c173110a5ece33d05d Signed-off-by: Stephen Finucane <sfinucan@redhat.com> --- doc/source/cli/commands.rst | 2 +- doc/source/contributor/command-wrappers.rst | 2 +- doc/source/contributor/plugins.rst | 5 ++--- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/doc/source/cli/commands.rst b/doc/source/cli/commands.rst index 97a829b558..497c79f0b9 100644 --- a/doc/source/cli/commands.rst +++ b/doc/source/cli/commands.rst @@ -306,7 +306,7 @@ Implementation -------------- The command structure is designed to support seamless addition of plugin -command modules via ``setuptools`` entry points. The plugin commands must +command modules via Python's *entry points* mechanism. The plugin commands must be subclasses of Cliff's ``command.Command`` object. See :ref:`plugins` for more information. diff --git a/doc/source/contributor/command-wrappers.rst b/doc/source/contributor/command-wrappers.rst index 2a5d92239d..cf4eece23a 100644 --- a/doc/source/contributor/command-wrappers.rst +++ b/doc/source/contributor/command-wrappers.rst @@ -7,7 +7,7 @@ We do this with a message logged at WARNING level before any command output is emitted. OpenStackClient command classes are derived from the ``cliff`` classes. -Cliff uses ``setuptools`` entry points for dispatching the parsed command +Cliff uses Python's *entry points* mechanism for dispatching the parsed command to the respective handler classes. This lends itself to modifying the command execution at run-time. diff --git a/doc/source/contributor/plugins.rst b/doc/source/contributor/plugins.rst index 374b274e6a..7ea48edd38 100644 --- a/doc/source/contributor/plugins.rst +++ b/doc/source/contributor/plugins.rst @@ -5,9 +5,8 @@ Plugins ======= The OpenStackClient plugin system is designed so that the plugin need only be -properly installed for OSC to find and use it. It utilizes the -``setuptools`` entry points mechanism to advertise to OSC the -plugin module and supported commands. +properly installed for OSC to find and use it. It utilizes Python's *entry +points* mechanism to advertise to OSC the plugin module and supported commands. Adoption ========