1 ==================

     2 PyAMS_form package

     3 ==================

     4 

     5 .. contents::

     6 

     7 

     8 What is PyAMS?

     9 ==============

    10 

    11 PyAMS (Pyramid Application Management Suite) is a small suite of packages written for applications

    12 and content management with the Pyramid framework.

    13 

    14 **PyAMS** is actually mainly used to manage web sites through content management applications (CMS,

    15 see PyAMS_content package), but many features are generic and can be used inside any kind of web

    16 application.

    17 

    18 All PyAMS documentation is available on `ReadTheDocs <https://pyams.readthedocs.io>`_

    19 

    20 

    21 What is PyAMS_form?

    22 ===================

    23 

    24 This package is an update of z3c.form package for use with Pyramid.

    25 

    26 PyAMS_form allows to use z3c.forms forms inside Pyramid applications, providing a bridge between

    27 initial Pyramid request and Zope publisher request used by z3c.form, with the help of the

    28 "pyramid_zope_request" package.

    29 

    30 PyAMS_form also provides custom templates for forms and for z3c.form widgets, to use them with the

    31 MyAMS framework used by PyAMS_skin and PyAMS_zmi packages, and provides a small set of additional

    32 widgets.

    33 

    34 This package also provides additional features, like form groups (which allows to group a set of

    35 form's widgets inside a fieldset), and a set of viewlet managers which can be used to extend a

    36 form's content using viewlets adapters; you can also extend a form by defining sub-forms and

    37 tab-forms adapters.

    38 

    39 

    40 Note about PyAMS_form API

    41 =========================

    42 

    43 PyAMS_form naming convention is actually a mix between z3c.form API, which is using camelCase

    44 naming convention, and Pyramid which is using standard Python's snake_case convention. A complete

    45 rewrite of PyAMS_form package, which will integrate all z3c.form features with a uniform API

    46 compliant with Pyramid's standards, is actually planned...