Mercurial Mercurial > pub > hg > cubicweb / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/book/pyramid/quickstart.rst
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Fri, 21 Apr 2017 09:57:04 +0200
changeset 12174 02b8325720d6
parent 12097 78a5c6a64fad
permissions -rw-r--r--
[rqlrewrite] Fix rewrite on ambiguities introduced by NOT relation or "is IN" type restriction When some inserted RQL snippet generate more solutions than the original RQL, the rewriter attempt to duplicate the snippet for each newly introduced solution. There are though some cases where we do not want this behaviour in case of ambiguities introduced by: * NOT(X relation Y) expression, since it won't be equivalent to NOT(X relation Y1, Y1 is Type1) OR NOT(X relation Y2, Y2 is Type2) ; * EXISTS(X relation Y, Y is IN (Type1, Type2) expression, since it's not actually necessary to split an explicitly introduced ambiguity (and it crash if we attempt to do so, so...). In test, we've to modify the `rewrite()` function because in the newly introduced test we need the same constraint to be applied to two variables in the original query, and this was not supported before. Notice the generated RQL in test is still *NOT CORRECT* "(EXISTS(NOT EXISTS() OR EXISTS(...))", or at least isn't optimal. This will be fixed in a forthcoming changeset. Related to #17074119

Quick start
===========

.. highlight:: bash

Prerequites
-----------

Install the *pyramid* flavour of CubicWeb (here with pip, possibly in a
virtualenv):

::

        pip install cubicweb[pyramid]


Instance creation and running
-----------------------------

In *backwards compatible* mode
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In this mode, you can simply create an instance of kind ``all-in-one`` with
the ``cubicweb-ctl create`` command. You'll then need to add a ``pyramid.ini``
file in your instance directory, see :ref:`pyramid_settings` for details about the
content of this file.

Start the instance with the :ref:`'pyramid' command <cubicweb-ctl_pyramid>`
instead of 'start':

::

    cubicweb-ctl pyramid --debug myinstance


Without *backwards compatibility*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In this mode, you can create an instance of kind ``pyramid`` as follow:

::

    cubicweb-ctl create -c pyramid <cube_name> <instance_name>

This will bootstrap a ``development.ini`` file typical of a Pyramid
application in the instance's directory. The new instance may then be launched
by any WSGI server, for instance with pserve_:

::

    pserve etc/cubicweb.d/<instance_name>/development.ini


In a pyramid application
~~~~~~~~~~~~~~~~~~~~~~~~

-   Create a pyramid application

-   Include cubicweb.pyramid:

    .. code-block:: python

        def includeme(config):
            # ...
            config.include('cubicweb.pyramid')
            # ...

-   Configure the instance name (in the .ini file):

    .. code-block:: ini

        cubicweb.instance = myinstance

-   Configure the base-url in all-in-one.conf to match the ones of the pyramid
    configuration (this is a temporary limitation).


.. _pserve: \
    http://docs.pylonsproject.org/projects/pyramid/en/latest/pscripts/pserve.html
cubicweb