9 **WARNING**: this is a "work-in-progress" documentation. All elements described here are not publicly available yet!!!

    12 Welcome to PyAMS's documentation!

    13 =================================

    14 

    15 At first, PyAMS was "Pyramid Application Management Skin". Actually, it's not only a simple skin but a whole "Suite" of

    16 applications and content management tools.

    17 

    18 PyAMS is built on top of MyAMS (My Application Management Skin), a small web client framework built on top of JQuery

    19 and Bootstrap, which was developed by the french national forestry office (ONF -- Office national des forêts --

    20 http://www.onf.fr) to build web applications in several languages (actually java, Python and PHP). The new ONF website

    21 is now completely handled with PyAMS framework.

    22 

    23 PyAMS is a multipurpose set of packages, providing tools including:

    24 

    25 * custom interfaces

    26 * custom registry annotations

    27 * custom security policy

    28 * local registry support

    29 * network protocols utilities (for HTTP and XML-RPC)

    30 * command line scripts

    31 * custom utilities.

    32 

    33 *PyAMS_content* is an important package providing content management features, which can be easily extended to manage

    34 your own content types. But PyAMS can also be used to manage any kind of application.

    35 

    36 If you just want to know how easy it is to create a PyAMS application instance, just read the :ref:`quickstart`!

    37 

    38 To know how PyAMS management interface looks like, look at :ref:`screenshots`!

    52 PyAMS applications architecture

    53 -------------------------------

    54 

    55 PyAMS applications are built on a small set of prerequisites and external components which *can* or, for some of them,

    56 *must* be included. Some of them are:

    57 

    58 * a mandatory shared ZODB;

    59 

    60 * a Redis or Memcached server, to handle cache and sessions;

    61 

    62 * a websockets server, used to handle desktop notifications; you can find information about this component in the

    63   :ref:`pyams_notify` chapter;

    64 

    65 * an Elasticsearch index, used to handle quick and optimized searching.

    66 

    67 See :ref:`architecture` to get all architecture details.

    75 * pyams_template (:ref:`pyams_template`)

    81 * pyams_utils (:ref:`pyams_utils`)

    82 

    83 * pyams_skin (:ref:`pyams_skin`)

    84 

    85 * pyams_form (:ref:`pyams_form`)

    86 

    87 * pyams_file (:ref:`pyams_file`)

    88 

    89 * pyams_i18n (:ref:`pyams_i18n`)

    90 

    91 * pyams_security (:ref:`pyams_security`)

    92 

    93 * pyams_zmi (:ref:`pyams_zmi`)

    94 

    95 * pyams_zodbbrowser (:ref:`pyams_zodbbrowser`)

    96 

    97 * pyams_catalog (:ref:`pyams_catalog`)

    98 

    99 * pyams_mail (:ref:`pyams_mail`)

   100 

   101 * pyams_ldap (:ref:`pyams_ldap`)

   102 

   103 * pyams_cache (:ref:`pyams_cache`)

   104 

   105 * pyams_alchemy (:ref:`pyams_alchemy`)

   106 

   107 * pyams_zmq (:ref:`pyams_zmq`)

   108 

   109 * pyams_scheduler (:ref:`pyams_scheduler`)

   110 

   111 * pyams_workflow (:ref:`pyams_workflow`)

   112 

   113 * pyams_thesaurus (:ref:`pyams_thesaurus`)

   114 

   115 * pyams_sequence (:ref:`pyams_sequence`)

   116 

   117 * pyams_portal (:ref:`pyams_portal`)

   118 

   119 * pyams_media (:ref:`pyams_media`)

   120 

   121 * pyams_notify (:ref:`pyams_notify`)

   122 

   123 * pyams_gis (:ref:`pyams_gis`)

   124 

   125 * pyams_content (:ref:`pyams_content`)

   126 

   127 * pyams_content_es (:ref:`pyams_content_es`)