cubicweb/pyramid/defaults.py
changeset 11631 faf279e33298
parent 11537 caf268942436
child 11967 83739be20fab
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/cubicweb/pyramid/defaults.py	Mon Sep 26 14:52:12 2016 +0200
@@ -0,0 +1,24 @@
+""" Defaults for a classical CubicWeb instance. """
+
+
+def includeme(config):
+    """ Enable the defaults that make the application behave like a classical
+    CubicWeb instance.
+
+    The following modules get included:
+
+    -   :func:`cubicweb.pyramid.session <cubicweb.pyramid.session.includeme>`
+    -   :func:`cubicweb.pyramid.auth <cubicweb.pyramid.auth.includeme>`
+    -   :func:`cubicweb.pyramid.login <cubicweb.pyramid.login.includeme>`
+
+    It is automatically included by the configuration system, unless the
+    following entry is added to the :ref:`pyramid_settings`:
+
+    .. code-block:: ini
+
+        cubicweb.defaults = no
+
+    """
+    config.include('cubicweb.pyramid.session')
+    config.include('cubicweb.pyramid.auth')
+    config.include('cubicweb.pyramid.login')