###########################################
YARHP: Yet Another REST Helper for Pyramid
###########################################

Yarhp extends the :ref:`Pyramid web framework <pyramid:index>` with the purpose of making it easy 
to build a RESTful web service by simply declaring your resources in an intuitive and plain way, hiding away the 
technicality and repetitiveness of otherwise rich pyramid api. It also defines default behaviors for CRUD actions for each resource, keeping it simple yet flexible to make adjustments.

    .. code-block:: python

        user = root.add('user', 'users')
        user.add('score', 'scores')

By simply adding the code above to your bootstrapping routine you define routes, views and validators for all the CRUD actions (index, show, create, etc) for your ``user`` resource. The second line not only defines everything you need for ``score`` resource, but also the relationship with the ``user``.
Thats a lot of (unittested) code written for you, dude !

.. toctree::
   start
   design
   glossary
   api
   upgrade


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* :ref:`glossary`