README.md
author Christophe de Vienne <christophe@unlish.com>
Thu, 31 Jul 2014 17:48:32 +0200
changeset 11492 b0b8942cdb80
parent 11481 10df276abb78
permissions -rw-r--r--
Separate into 4 modules * init_instance: load the cubicweb repository from the `pyramid_cubicweb.instance` configuration key * defaults: provides cw-like defaults for the authentication and session management * core: make cubicweb use the authentication and session management of pyramid. It assumes the application provides the auth policies and session factory, and that the `cubicweb.*` registry entries are correctly initialised. This is this only required module or pyramid_cubicweb, the other ones are optional if the application provides its own versions of what they do. * bwcompat: provides a catchall route that delegate the request handling to an old-fashion cubicweb publisher (ie using url_resolver and controllers). Related to #4291173

[pyramid\_cubicweb][] is one specific way of integrating [CubicWeb][] with a
[Pyramid][] web application.

### Features

* provides a default route that let a cubicweb instance handle the request.

### Usage

To use, install pyramid\_cubicweb in your python environment,
and then [include][] the package:

    config.include('pyramid_cubicweb')

### Configuration

Requires the following [INI setting / environment variable][]:

* `cubicweb.instance` / `CUBICWEB_INSTANCE`


[pyramid\_cubicweb]: https://www.cubicweb.org/project/pyramid-cubicweb
[CubicWeb]: http://www.cubicweb.com/
[Pyramid]: http://pypi.python.org/pypi/pyramid
[include]: http://docs.pylonsproject.org/projects/pyramid/en/latest/api/config.html#pyramid.config.Configurator.include
[INI setting / environment variable]: http://docs.pylonsproject.org/projects/pyramid/en/latest/narr/environment.html#adding-a-custom-setting