1 .. PyAMS_utils documentation master file, created by

     2    sphinx-quickstart on Tue Nov 15 16:18:42 2016.

     3    You can adapt this file completely to your liking, but it should at least

     4    contain the root `toctree` directive.

     5 

     6 .. _index:

     7 

     8 

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

    10 

    11 

    12 Welcome to PyAMS_utils'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_utils is a multipurpose utilities package, providing tools including:

    19 

    20 * custom interfaces

    21 * custom ZCA registry annotations

    22 * local registry support

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

    24 * custom utilities

    25 * a command line script to handle database upgrade process

    26 

    27 

    28 .. toctree::

    29    :maxdepth: 2

    30 

    31    zodb

    32    install

    33    zca

    34    site

    35    traverser

    36    tales

    37    utilities

    38 

    39 

    40 PyAMS applications architecture

    41 -------------------------------

    42 

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

    44 be included. Some of them are:

    45 

    46 * a mandatory shared ZODB;

    47 

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

    49   :ref:`pyams_notify` chapter;

    50 

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

    52 

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

    54 

    55 

    56 PyAMS external packages

    57 -----------------------

    58 

    59 PyAMS is built on many external packages, and provides a whole set of extensions. He re is a list of them:

    60 

    61 * pyams_template (:ref:`pyams_template`)

    62 

    63 * pyams_viewlet (:ref:`pyams_viewlet`)

    64 

    65 * pyams_pagelet (:ref:`pyams_pagelet`)

    66 

    67 * pyams_utils (:ref:`pyams_utils`)

    68 

    69 * pyams_skin (:ref:`pyams_skin`)

    70 

    71 * pyams_form (:ref:`pyams_form`)

    72 

    73 * pyams_file (:ref:`pyams_file`)

    74 

    75 * pyams_i18n (:ref:`pyams_i18n`)

    76 

    77 * pyams_security (:ref:`pyams_security`)

    78 

    79 * pyams_zmi (:ref:`pyams_zmi`)

    80 

    81 * pyams_zodbbrowser (:ref:`pyams_zodbbrowser`)

    82 

    83 * pyams_catalog (:ref:`pyams_catalog`)

    84 

    85 * pyams_mail (:ref:`pyams_mail`)

    86 

    87 * pyams_ldap (:ref:`pyams_ldap`)

    88 

    89 * pyams_cache (:ref:`pyams_cache`)

    90 

    91 * pyams_alchemy (:ref:`pyams_alchemy`)

    92 

    93 * pyams_zmq (:ref:`pyams_zmq`)

    94 

    95 * pyams_scheduler (:ref:`pyams_scheduler`)

    96 

    97 * pyams_workflow (:ref:`pyams_workflow`)

    98 

    99 * pyams_thesaurus (:ref:`pyams_thesaurus`)

   100 

   101 * pyams_sequence (:ref:`pyams_sequence`)

   102 

   103 * pyams_portal (:ref:`pyams_portal`)

   104 

   105 * pyams_media (:ref:`pyams_media`)

   106 

   107 * pyams_notify (:ref:`pyams_notify`)

   108 

   109 * pyams_gis (:ref:`pyams_gis`)

   110 

   111 * pyams_content (:ref:`pyams_content`)

   112 

   113 * pyams_content_es (:ref:`pyams_content_es`)

   114 œ

   115 

   116 

   117 Indices and tables

   118 ------------------

   119 

   120 * :ref:`genindex`

   121 * :ref:`modules`

   122 * :ref:`modindex`

   123 * :ref:`search`