From 76c7ab5c85b6c9271664d2c9227cd7f7b785889a Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Mon, 20 Feb 2017 09:37:51 -0600 Subject: [PATCH] Remove text about OSC as a plugin requirement python-openstackclient should not be in a plugin's requirements.txt as it will pull in the OSC dependencies that may not be desirable. Change-Id: Id72745704ec70cab438e766dbac21a838fccb523 --- doc/source/plugins.rst | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst index eafe5e8fa0..054e552fe7 100644 --- a/doc/source/plugins.rst +++ b/doc/source/plugins.rst @@ -190,12 +190,15 @@ unit tests for the plugin commands: Requirements ------------ -OSC must be included in ``requirements.txt`` or ``test-requirements.txt`` -for the plugin project. Update ``requirements.txt`` if the plugin project -considers the CLI a required feature. Update ``test-requirements.txt`` if -the plugin project can be installed as a library with the CLI being an +OSC should be included in the plugin's ``test-requirements.txt`` if +the plugin can be installed as a library with the CLI being an optional feature (available when OSC is also installed). +OSC should not appear in ``requirements.txt`` unless the plugin project +wants OSC and all of its dependencies installed with it. This is +specifically not a good idea for plugins that are also libraries +installed with OpenStack services. + .. code-block:: ini python-openstackclient>=X.Y.Z # Apache-2.0