Skip to content

Commit 76c7ab5

Browse files
author
Dean Troyer
committed
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
1 parent 98d5641 commit 76c7ab5

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

doc/source/plugins.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,12 +190,15 @@ unit tests for the plugin commands:
190190
Requirements
191191
------------
192192

193-
OSC must be included in ``requirements.txt`` or ``test-requirements.txt``
194-
for the plugin project. Update ``requirements.txt`` if the plugin project
195-
considers the CLI a required feature. Update ``test-requirements.txt`` if
196-
the plugin project can be installed as a library with the CLI being an
193+
OSC should be included in the plugin's ``test-requirements.txt`` if
194+
the plugin can be installed as a library with the CLI being an
197195
optional feature (available when OSC is also installed).
198196

197+
OSC should not appear in ``requirements.txt`` unless the plugin project
198+
wants OSC and all of its dependencies installed with it. This is
199+
specifically not a good idea for plugins that are also libraries
200+
installed with OpenStack services.
201+
199202
.. code-block:: ini
200203
201204
python-openstackclient>=X.Y.Z # Apache-2.0

0 commit comments

Comments
 (0)