Merge pull request #711 from glasserc/deprecation

Indicate that Cliquet is now deprecated

README.rst

@@ -1,3 +1,15 @@
+Deprecation Notice
+==================
+
+Cliquet has been folded into the `Kinto
+<https://github.com/Kinto/kinto/>`_ package under the new name
+``kinto.core``. You should update your code to import ``kinto.core``
+instead of ``cliquet``, and all ``cliquet.*`` settings are now
+prefixed with ``kinto`` instead. See
+https://mail.mozilla.org/pipermail/kinto/2016-May/000119.html for more
+about the background for this decision.
+
+
 Cliquet
 =======
 

cliquet/__init__.py

@@ -16,6 +16,18 @@
 from cliquet.logs import logger
 
 
+import warnings
+
+DEPRECATION_MESSAGE = ''.join([
+    "Cliquet is now deprecated. Please update to kinto.core at ",
+    "https://github.com/Kinto/kinto. See ",
+    "https://github.com/mozilla-services/cliquet/issues/687 ",
+    "for more information.",
+    ])
+
+warnings.warn(DEPRECATION_MESSAGE, DeprecationWarning)
+
+
 # Module version, as defined in PEP-0396.
 __version__ = pkg_resources.get_distribution(__package__).version
 
@@ -115,6 +127,7 @@ def init_from_settings(cls, settings):
 
 
 def includeme(config):
+
     settings = config.get_settings()
 
     # Heartbeat registry.
@@ -156,6 +169,8 @@ def add_api_capability(config, identifier, description="", url="", **kw):
         step_func = config.maybe_dotted(step)
         step_func(config)
 
+    logger.warn(DEPRECATION_MESSAGE)
+
     # Custom helpers.
     config.add_request_method(follow_subrequest)
     config.add_request_method(authentication.prefixed_userid, property=True)