openstack/python-openstackclient
Code Issues Proposed changes

Remove text about OSC as a plugin requirement

Browse Source 
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
This commit is contained in:
Dean Troyer 2017-02-20 09:37:51 -06:00
parent 98d5641ac5
commit 76c7ab5c85
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/plugins.rst
View File

@ -190,12 +190,15 @@ unit tests for the plugin commands:
Requirements Requirements
------------ ------------
OSC must be included in ``requirements.txt`` or ``test-requirements.txt`` OSC should be included in the plugin's ``test-requirements.txt`` if
for the plugin project. Update ``requirements.txt`` if the plugin project the plugin can be installed as a library with the CLI being an
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
optional feature (available when OSC is also installed). 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 .. code-block:: ini
python-openstackclient>=X.Y.Z # Apache-2.0 python-openstackclient>=X.Y.Z # Apache-2.0