--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/build/html/index.html Sun Jan 14 11:48:51 2018 +0100
@@ -0,0 +1,221 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <title>Welcome to PyAMS_utils’s documentation! — PyAMS User Guide 0.1.0 documentation</title>
+ <link rel="stylesheet" href="_static/pyramid.css" type="text/css" />
+ <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: './',
+ VERSION: '0.1.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="_static/jquery.js"></script>
+ <script type="text/javascript" src="_static/underscore.js"></script>
+ <script type="text/javascript" src="_static/doctools.js"></script>
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+ <link rel="next" title="Creating ZODB" href="zodb.html" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" />
+<!--[if lte IE 6]>
+<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
+<![endif]-->
+
+ </head>
+ <body>
+
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="zodb.html" title="Creating ZODB"
+ accesskey="N">next</a> |</li>
+ <li class="nav-item nav-item-0"><a href="#">PyAMS User Guide 0.1.0 documentation</a> »</li>
+ </ul>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body" role="main">
+
+ <p id="index"><strong>WARNING</strong>: this is a “work-in-progress” documentation. All elements described here are not publicly available yet!!!</p>
+<div class="section" id="welcome-to-pyams-utils-s-documentation">
+<h1>Welcome to PyAMS_utils’s documentation!<a class="headerlink" href="#welcome-to-pyams-utils-s-documentation" title="Permalink to this headline">¶</a></h1>
+<p>At first, PyAMS was “Pyramid Application Management Skin”. Actually, it’s not only a simple skin but a whole “Suite” of
+applications and content management tools.</p>
+<p>PyAMS_utils is a multipurpose utilities package, providing tools including:</p>
+<ul class="simple">
+<li>custom interfaces</li>
+<li>custom ZCA registry annotations</li>
+<li>local registry support</li>
+<li>network protocols utilities (for HTTP and XML-RPC)</li>
+<li>custom utilities</li>
+<li>a command line script to handle database upgrade process</li>
+</ul>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="zodb.html">Creating ZODB</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="zodb.html#installing-a-zeo-server">Installing a ZEO server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="zodb.html#installing-a-relstorage-server">Installing a RelStorage server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="zodb.html#installing-a-newtdb-server">Installing a NewtDB server</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="install.html">Installing PyAMS</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="install.html#creating-initial-buildout">Creating initial buildout</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#environment-settings">Environment settings</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#initializing-the-database">Initializing the database</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#initializing-elasticsearch-index">Initializing Elasticsearch index</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#nltk-initialization">NLTK initialization</a></li>
+<li class="toctree-l2"><a class="reference internal" href="install.html#starting-the-application">Starting the application</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="zca.html">Managing ZCA with PyAMS</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="zca.html#local-utilities">Local utilities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="zca.html#defining-site-root">Defining site root</a></li>
+<li class="toctree-l2"><a class="reference internal" href="zca.html#registering-global-utilities">Registering global utilities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="zca.html#registering-local-utilities">Registering local utilities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="zca.html#looking-for-utilities">Looking for utilities</a></li>
+<li class="toctree-l2"><a class="reference internal" href="zca.html#registering-adapters">Registering adapters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="zca.html#registering-vocabularies">Registering vocabularies</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="site.html">PyAMS site management</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="site.html#pyams-upgrade-command-line-script"><em>pyams_upgrade</em> command line script</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="traverser.html">PyAMS namespace traverser</a></li>
+<li class="toctree-l1"><a class="reference internal" href="tales.html">Custom TALES extensions</a></li>
+<li class="toctree-l1"><a class="reference internal" href="utilities.html">Custom PyAMS utilities</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="utilities.html#server-timezone">Server timezone</a></li>
+<li class="toctree-l2"><a class="reference internal" href="utilities.html#zeo-connection">ZEO connection</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="pyams-applications-architecture">
+<h2>PyAMS applications architecture<a class="headerlink" href="#pyams-applications-architecture" title="Permalink to this headline">¶</a></h2>
+<p>PyAMS applications are built on a small set of prerequisites and components which <em>can</em> or, for some of them, <em>must</em>
+be included. Some of them are:</p>
+<ul class="simple">
+<li>a mandatory shared ZODB;</li>
+<li>a websockets server, used to handle desktop notifications; you can find information about this component in the
+<a class="reference internal" href="pyams_notify.html#pyams-notify"><span class="std std-ref">PyAMS notification services</span></a> chapter;</li>
+<li>a Redis or Memcached server, to handle cache and sessions;</li>
+<li>an Elasticsearch index, used to handle quick and optimized searching.</li>
+</ul>
+</div>
+<div class="section" id="pyams-external-packages">
+<h2>PyAMS external packages<a class="headerlink" href="#pyams-external-packages" title="Permalink to this headline">¶</a></h2>
+<p>PyAMS is built on many external packages, and provides a whole set of extensions. He re is a list of them:</p>
+<ul class="simple">
+<li>pyams_template (<a class="reference internal" href="pyams_template.html#pyams-template"><span class="std std-ref">PyAMS templates</span></a>)</li>
+<li>pyams_viewlet (<a class="reference internal" href="pyams_viewlet.html#pyams-viewlet"><span class="std std-ref">PyAMS viewlets</span></a>)</li>
+<li>pyams_pagelet (<a class="reference internal" href="pyams_pagelet.html#pyams-pagelet"><span class="std std-ref">PyAMS pagelets</span></a>)</li>
+<li>pyams_utils (<a class="reference internal" href="pyams_utils.html#pyams-utils"><span class="std std-ref">PyAMS utilities</span></a>)</li>
+<li>pyams_skin (<a class="reference internal" href="pyams_skin.html#pyams-skin"><span class="std std-ref">PyAMS skin utilities</span></a>)</li>
+<li>pyams_form (<a class="reference internal" href="pyams_form.html#pyams-form"><span class="std std-ref">PyAMS forms</span></a>)</li>
+<li>pyams_file (<span class="xref std std-ref">pyams_file</span>)</li>
+<li>pyams_i18n (<a class="reference internal" href="pyams_i18n.html#pyams-i18n"><span class="std std-ref">PyAMS internationalization</span></a>)</li>
+<li>pyams_security (<a class="reference internal" href="pyams_security.html#pyams-security"><span class="std std-ref">PyAMS security</span></a>)</li>
+<li>pyams_zmi (<a class="reference internal" href="pyams_zmi.html#pyams-zmi"><span class="std std-ref">PyAMS management interface</span></a>)</li>
+<li>pyams_zodbbrowser (<span class="xref std std-ref">pyams_zodbbrowser</span>)</li>
+<li>pyams_catalog (<span class="xref std std-ref">pyams_catalog</span>)</li>
+<li>pyams_mail (<span class="xref std std-ref">pyams_mail</span>)</li>
+<li>pyams_ldap (<span class="xref std std-ref">pyams_ldap</span>)</li>
+<li>pyams_cache (<a class="reference internal" href="pyams_cache.html#pyams-cache"><span class="std std-ref">PyAMS cache management</span></a>)</li>
+<li>pyams_alchemy (<a class="reference internal" href="pyams_alchemy.html#pyams-alchemy"><span class="std std-ref">PyAMS SQLAlchemy integration</span></a>)</li>
+<li>pyams_zmq (<span class="xref std std-ref">pyams_zmq</span>)</li>
+<li>pyams_scheduler (<span class="xref std std-ref">pyams_scheduler</span>)</li>
+<li>pyams_workflow (<span class="xref std std-ref">pyams_workflow</span>)</li>
+<li>pyams_thesaurus (<a class="reference internal" href="pyams_thesaurus.html#pyams-thesaurus"><span class="std std-ref">PyAMS thesaurus manager</span></a>)</li>
+<li>pyams_sequence (<span class="xref std std-ref">pyams_sequence</span>)</li>
+<li>pyams_portal (<span class="xref std std-ref">pyams_portal</span>)</li>
+<li>pyams_media (<span class="xref std std-ref">pyams_media</span>)</li>
+<li>pyams_notify (<a class="reference internal" href="pyams_notify.html#pyams-notify"><span class="std std-ref">PyAMS notification services</span></a>)</li>
+<li>pyams_gis (<span class="xref std std-ref">pyams_gis</span>)</li>
+<li>pyams_content (<span class="xref std std-ref">pyams_content</span>)</li>
+<li>pyams_content_es (<span class="xref std std-ref">pyams_content_es</span>)</li>
+</ul>
+<p>œ</p>
+</div>
+<div class="section" id="indices-and-tables">
+<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
+<li><a class="reference internal" href="modules.html#modules"><span class="std std-ref">Modules list</span></a></li>
+<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
+<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
+</ul>
+</div>
+</div>
+
+
+ </div>
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+ <h3><a href="#">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Welcome to PyAMS_utils’s documentation!</a><ul>
+<li><a class="reference internal" href="#pyams-applications-architecture">PyAMS applications architecture</a></li>
+<li><a class="reference internal" href="#pyams-external-packages">PyAMS external packages</a></li>
+<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
+</ul>
+</li>
+</ul>
+
+ <h4>Next topic</h4>
+ <p class="topless"><a href="zodb.html"
+ title="next chapter">Creating ZODB</a></p>
+<div id="searchbox" style="display: none" role="search">
+ <h3>Quick search</h3>
+ <form class="search" action="search.html" method="get">
+ <div><input type="text" name="q" /></div>
+ <div><input type="submit" value="Go" /></div>
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related" role="navigation" aria-label="related navigation">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li class="right" >
+ <a href="zodb.html" title="Creating ZODB"
+ >next</a> |</li>
+ <li class="nav-item nav-item-0"><a href="#">PyAMS User Guide 0.1.0 documentation</a> »</li>
+ </ul>
+ </div>
+ <div class="footer" role="contentinfo">
+ © Copyright 2017, Thierry Florac.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5.
+ </div>
+ </body>
+</html>
\ No newline at end of file