Proper deprecations for modules

Use debtcollector and update docs for deprecating the apiclient,
apiclient.exceptions, middleware.s3_token, and v2_0.shell modules.

bp deprecations

Change-Id: I84e8eac39a209210542f19de08d4c3de15a9dcac

keystoneclient/apiclient/__init__.py

@@ -13,7 +13,16 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-import warnings
+"""Deprecated.
+
+.. warning::
+
+  This module is deprecated as of the 1.7.0 release in favor of
+  :py:mod:`keystoneclient.exceptions` and may be removed in the 2.0.0 release.
+
+"""
+
+from debtcollector import removals
 
 from keystoneclient import exceptions
 
@@ -22,9 +31,10 @@ from keystoneclient import exceptions
 # to report 'deprecated' status of exceptions for next kind of imports
 #       from keystoneclient.apiclient import exceptions
 
-warnings.warn("The 'keystoneclient.apiclient' module is deprecated since "
+removals.removed_module('keystoneclient.apiclient',
-              "v.0.7.1. Use 'keystoneclient.exceptions' instead of this "
+                        replacement='keystoneclient.exceptions',
-              "module.", DeprecationWarning)
+                        version='0.7.1',
+                        removal_version='2.0')
 
 __all__ = [
     'exceptions',

keystoneclient/apiclient/exceptions.py

@@ -20,14 +20,15 @@
 Exception definitions.
 
 Deprecated since v0.7.1. Use 'keystoneclient.exceptions' instead of
-this module.
+this module. This module may be removed in the 2.0.0 release.
 """
 
-import warnings
+from debtcollector import removals
 
 from keystoneclient.exceptions import *     # noqa
 
 
-warnings.warn("The 'keystoneclient.apiclient.exceptions' module is deprecated "
+removals.removed_module('keystoneclient.apiclient.exceptions',
-              "since v.0.7.1. Use 'keystoneclient.exceptions' instead of this "
+                        replacement='keystoneclient.exceptions',
-              "module.", DeprecationWarning)
+                        version='0.7.1',
+                        removal_version='2.0')

keystoneclient/middleware/s3_token.py

@@ -22,6 +22,12 @@
 """
 S3 TOKEN MIDDLEWARE
 
+.. warning::
+
+  This module is DEPRECATED and may be removed in the 2.0.0 release. The
+  s3_token middleware has been moved to the `keystonemiddleware repository
+  <http://docs.openstack.org/developer/keystonemiddleware/>`_.
+
 This WSGI component:
 
 * Get a request from the swift3 middleware with an S3 Authorization

keystoneclient/v2_0/shell.py

@@ -15,7 +15,8 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 """
-This module is pending deprecation in favor of python-openstackclient.
+This module is deprecated as of the 1.7.0 release in favor of
+python-openstackclient and may be removed in the 2.0.0 release.
 
 Bug fixes are welcome, but new features should be exposed to the CLI by
 python-openstackclient after being added to the python-keystoneclient library.

requirements.txt

@@ -7,6 +7,7 @@ pbr<2.0,>=1.3
 argparse
 Babel>=1.3
 iso8601>=0.1.9
+debtcollector>=0.3.0  # Apache-2.0
 netaddr>=0.7.12
 oslo.config>=1.11.0 # Apache-2.0
 oslo.i18n>=1.5.0 # Apache-2.0