|
1 |
|
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 |
|
5 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
6 <head> |
|
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|
8 <title>Welcome to PyAMS_utils’s documentation! — PyAMS User Guide 0.1.0 documentation</title> |
|
9 <link rel="stylesheet" href="_static/pyramid.css" type="text/css" /> |
|
10 <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
|
11 <script type="text/javascript"> |
|
12 var DOCUMENTATION_OPTIONS = { |
|
13 URL_ROOT: './', |
|
14 VERSION: '0.1.0', |
|
15 COLLAPSE_INDEX: false, |
|
16 FILE_SUFFIX: '.html', |
|
17 HAS_SOURCE: true, |
|
18 SOURCELINK_SUFFIX: '.txt' |
|
19 }; |
|
20 </script> |
|
21 <script type="text/javascript" src="_static/jquery.js"></script> |
|
22 <script type="text/javascript" src="_static/underscore.js"></script> |
|
23 <script type="text/javascript" src="_static/doctools.js"></script> |
|
24 <link rel="index" title="Index" href="genindex.html" /> |
|
25 <link rel="search" title="Search" href="search.html" /> |
|
26 <link rel="next" title="Creating ZODB" href="zodb.html" /> |
|
27 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" /> |
|
28 <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" /> |
|
29 <!--[if lte IE 6]> |
|
30 <link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" /> |
|
31 <![endif]--> |
|
32 |
|
33 </head> |
|
34 <body> |
|
35 |
|
36 <div class="related" role="navigation" aria-label="related navigation"> |
|
37 <h3>Navigation</h3> |
|
38 <ul> |
|
39 <li class="right" style="margin-right: 10px"> |
|
40 <a href="genindex.html" title="General Index" |
|
41 accesskey="I">index</a></li> |
|
42 <li class="right" > |
|
43 <a href="py-modindex.html" title="Python Module Index" |
|
44 >modules</a> |</li> |
|
45 <li class="right" > |
|
46 <a href="zodb.html" title="Creating ZODB" |
|
47 accesskey="N">next</a> |</li> |
|
48 <li class="nav-item nav-item-0"><a href="#">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
49 </ul> |
|
50 </div> |
|
51 |
|
52 <div class="document"> |
|
53 <div class="documentwrapper"> |
|
54 <div class="bodywrapper"> |
|
55 <div class="body" role="main"> |
|
56 |
|
57 <p id="index"><strong>WARNING</strong>: this is a “work-in-progress” documentation. All elements described here are not publicly available yet!!!</p> |
|
58 <div class="section" id="welcome-to-pyams-utils-s-documentation"> |
|
59 <h1>Welcome to PyAMS_utils’s documentation!<a class="headerlink" href="#welcome-to-pyams-utils-s-documentation" title="Permalink to this headline">¶</a></h1> |
|
60 <p>At first, PyAMS was “Pyramid Application Management Skin”. Actually, it’s not only a simple skin but a whole “Suite” of |
|
61 applications and content management tools.</p> |
|
62 <p>PyAMS_utils is a multipurpose utilities package, providing tools including:</p> |
|
63 <ul class="simple"> |
|
64 <li>custom interfaces</li> |
|
65 <li>custom ZCA registry annotations</li> |
|
66 <li>local registry support</li> |
|
67 <li>network protocols utilities (for HTTP and XML-RPC)</li> |
|
68 <li>custom utilities</li> |
|
69 <li>a command line script to handle database upgrade process</li> |
|
70 </ul> |
|
71 <div class="toctree-wrapper compound"> |
|
72 <ul> |
|
73 <li class="toctree-l1"><a class="reference internal" href="zodb.html">Creating ZODB</a><ul> |
|
74 <li class="toctree-l2"><a class="reference internal" href="zodb.html#installing-a-zeo-server">Installing a ZEO server</a></li> |
|
75 <li class="toctree-l2"><a class="reference internal" href="zodb.html#installing-a-relstorage-server">Installing a RelStorage server</a></li> |
|
76 <li class="toctree-l2"><a class="reference internal" href="zodb.html#installing-a-newtdb-server">Installing a NewtDB server</a></li> |
|
77 </ul> |
|
78 </li> |
|
79 <li class="toctree-l1"><a class="reference internal" href="install.html">Installing PyAMS</a><ul> |
|
80 <li class="toctree-l2"><a class="reference internal" href="install.html#creating-initial-buildout">Creating initial buildout</a></li> |
|
81 <li class="toctree-l2"><a class="reference internal" href="install.html#environment-settings">Environment settings</a></li> |
|
82 <li class="toctree-l2"><a class="reference internal" href="install.html#initializing-the-database">Initializing the database</a></li> |
|
83 <li class="toctree-l2"><a class="reference internal" href="install.html#initializing-elasticsearch-index">Initializing Elasticsearch index</a></li> |
|
84 <li class="toctree-l2"><a class="reference internal" href="install.html#nltk-initialization">NLTK initialization</a></li> |
|
85 <li class="toctree-l2"><a class="reference internal" href="install.html#starting-the-application">Starting the application</a></li> |
|
86 </ul> |
|
87 </li> |
|
88 <li class="toctree-l1"><a class="reference internal" href="zca.html">Managing ZCA with PyAMS</a><ul> |
|
89 <li class="toctree-l2"><a class="reference internal" href="zca.html#local-utilities">Local utilities</a></li> |
|
90 <li class="toctree-l2"><a class="reference internal" href="zca.html#defining-site-root">Defining site root</a></li> |
|
91 <li class="toctree-l2"><a class="reference internal" href="zca.html#registering-global-utilities">Registering global utilities</a></li> |
|
92 <li class="toctree-l2"><a class="reference internal" href="zca.html#registering-local-utilities">Registering local utilities</a></li> |
|
93 <li class="toctree-l2"><a class="reference internal" href="zca.html#looking-for-utilities">Looking for utilities</a></li> |
|
94 <li class="toctree-l2"><a class="reference internal" href="zca.html#registering-adapters">Registering adapters</a></li> |
|
95 <li class="toctree-l2"><a class="reference internal" href="zca.html#registering-vocabularies">Registering vocabularies</a></li> |
|
96 </ul> |
|
97 </li> |
|
98 <li class="toctree-l1"><a class="reference internal" href="site.html">PyAMS site management</a><ul> |
|
99 <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> |
|
100 </ul> |
|
101 </li> |
|
102 <li class="toctree-l1"><a class="reference internal" href="traverser.html">PyAMS namespace traverser</a></li> |
|
103 <li class="toctree-l1"><a class="reference internal" href="tales.html">Custom TALES extensions</a></li> |
|
104 <li class="toctree-l1"><a class="reference internal" href="utilities.html">Custom PyAMS utilities</a><ul> |
|
105 <li class="toctree-l2"><a class="reference internal" href="utilities.html#server-timezone">Server timezone</a></li> |
|
106 <li class="toctree-l2"><a class="reference internal" href="utilities.html#zeo-connection">ZEO connection</a></li> |
|
107 </ul> |
|
108 </li> |
|
109 </ul> |
|
110 </div> |
|
111 <div class="section" id="pyams-applications-architecture"> |
|
112 <h2>PyAMS applications architecture<a class="headerlink" href="#pyams-applications-architecture" title="Permalink to this headline">¶</a></h2> |
|
113 <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> |
|
114 be included. Some of them are:</p> |
|
115 <ul class="simple"> |
|
116 <li>a mandatory shared ZODB;</li> |
|
117 <li>a websockets server, used to handle desktop notifications; you can find information about this component in the |
|
118 <a class="reference internal" href="pyams_notify.html#pyams-notify"><span class="std std-ref">PyAMS notification services</span></a> chapter;</li> |
|
119 <li>a Redis or Memcached server, to handle cache and sessions;</li> |
|
120 <li>an Elasticsearch index, used to handle quick and optimized searching.</li> |
|
121 </ul> |
|
122 </div> |
|
123 <div class="section" id="pyams-external-packages"> |
|
124 <h2>PyAMS external packages<a class="headerlink" href="#pyams-external-packages" title="Permalink to this headline">¶</a></h2> |
|
125 <p>PyAMS is built on many external packages, and provides a whole set of extensions. He re is a list of them:</p> |
|
126 <ul class="simple"> |
|
127 <li>pyams_template (<a class="reference internal" href="pyams_template.html#pyams-template"><span class="std std-ref">PyAMS templates</span></a>)</li> |
|
128 <li>pyams_viewlet (<a class="reference internal" href="pyams_viewlet.html#pyams-viewlet"><span class="std std-ref">PyAMS viewlets</span></a>)</li> |
|
129 <li>pyams_pagelet (<a class="reference internal" href="pyams_pagelet.html#pyams-pagelet"><span class="std std-ref">PyAMS pagelets</span></a>)</li> |
|
130 <li>pyams_utils (<a class="reference internal" href="pyams_utils.html#pyams-utils"><span class="std std-ref">PyAMS utilities</span></a>)</li> |
|
131 <li>pyams_skin (<a class="reference internal" href="pyams_skin.html#pyams-skin"><span class="std std-ref">PyAMS skin utilities</span></a>)</li> |
|
132 <li>pyams_form (<a class="reference internal" href="pyams_form.html#pyams-form"><span class="std std-ref">PyAMS forms</span></a>)</li> |
|
133 <li>pyams_file (<span class="xref std std-ref">pyams_file</span>)</li> |
|
134 <li>pyams_i18n (<a class="reference internal" href="pyams_i18n.html#pyams-i18n"><span class="std std-ref">PyAMS internationalization</span></a>)</li> |
|
135 <li>pyams_security (<a class="reference internal" href="pyams_security.html#pyams-security"><span class="std std-ref">PyAMS security</span></a>)</li> |
|
136 <li>pyams_zmi (<a class="reference internal" href="pyams_zmi.html#pyams-zmi"><span class="std std-ref">PyAMS management interface</span></a>)</li> |
|
137 <li>pyams_zodbbrowser (<span class="xref std std-ref">pyams_zodbbrowser</span>)</li> |
|
138 <li>pyams_catalog (<span class="xref std std-ref">pyams_catalog</span>)</li> |
|
139 <li>pyams_mail (<span class="xref std std-ref">pyams_mail</span>)</li> |
|
140 <li>pyams_ldap (<span class="xref std std-ref">pyams_ldap</span>)</li> |
|
141 <li>pyams_cache (<a class="reference internal" href="pyams_cache.html#pyams-cache"><span class="std std-ref">PyAMS cache management</span></a>)</li> |
|
142 <li>pyams_alchemy (<a class="reference internal" href="pyams_alchemy.html#pyams-alchemy"><span class="std std-ref">PyAMS SQLAlchemy integration</span></a>)</li> |
|
143 <li>pyams_zmq (<span class="xref std std-ref">pyams_zmq</span>)</li> |
|
144 <li>pyams_scheduler (<span class="xref std std-ref">pyams_scheduler</span>)</li> |
|
145 <li>pyams_workflow (<span class="xref std std-ref">pyams_workflow</span>)</li> |
|
146 <li>pyams_thesaurus (<a class="reference internal" href="pyams_thesaurus.html#pyams-thesaurus"><span class="std std-ref">PyAMS thesaurus manager</span></a>)</li> |
|
147 <li>pyams_sequence (<span class="xref std std-ref">pyams_sequence</span>)</li> |
|
148 <li>pyams_portal (<span class="xref std std-ref">pyams_portal</span>)</li> |
|
149 <li>pyams_media (<span class="xref std std-ref">pyams_media</span>)</li> |
|
150 <li>pyams_notify (<a class="reference internal" href="pyams_notify.html#pyams-notify"><span class="std std-ref">PyAMS notification services</span></a>)</li> |
|
151 <li>pyams_gis (<span class="xref std std-ref">pyams_gis</span>)</li> |
|
152 <li>pyams_content (<span class="xref std std-ref">pyams_content</span>)</li> |
|
153 <li>pyams_content_es (<span class="xref std std-ref">pyams_content_es</span>)</li> |
|
154 </ul> |
|
155 <p>œ</p> |
|
156 </div> |
|
157 <div class="section" id="indices-and-tables"> |
|
158 <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2> |
|
159 <ul class="simple"> |
|
160 <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li> |
|
161 <li><a class="reference internal" href="modules.html#modules"><span class="std std-ref">Modules list</span></a></li> |
|
162 <li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li> |
|
163 <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li> |
|
164 </ul> |
|
165 </div> |
|
166 </div> |
|
167 |
|
168 |
|
169 </div> |
|
170 </div> |
|
171 </div> |
|
172 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
|
173 <div class="sphinxsidebarwrapper"> |
|
174 <h3><a href="#">Table Of Contents</a></h3> |
|
175 <ul> |
|
176 <li><a class="reference internal" href="#">Welcome to PyAMS_utils’s documentation!</a><ul> |
|
177 <li><a class="reference internal" href="#pyams-applications-architecture">PyAMS applications architecture</a></li> |
|
178 <li><a class="reference internal" href="#pyams-external-packages">PyAMS external packages</a></li> |
|
179 <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li> |
|
180 </ul> |
|
181 </li> |
|
182 </ul> |
|
183 |
|
184 <h4>Next topic</h4> |
|
185 <p class="topless"><a href="zodb.html" |
|
186 title="next chapter">Creating ZODB</a></p> |
|
187 <div id="searchbox" style="display: none" role="search"> |
|
188 <h3>Quick search</h3> |
|
189 <form class="search" action="search.html" method="get"> |
|
190 <div><input type="text" name="q" /></div> |
|
191 <div><input type="submit" value="Go" /></div> |
|
192 <input type="hidden" name="check_keywords" value="yes" /> |
|
193 <input type="hidden" name="area" value="default" /> |
|
194 </form> |
|
195 </div> |
|
196 <script type="text/javascript">$('#searchbox').show(0);</script> |
|
197 </div> |
|
198 </div> |
|
199 <div class="clearer"></div> |
|
200 </div> |
|
201 <div class="related" role="navigation" aria-label="related navigation"> |
|
202 <h3>Navigation</h3> |
|
203 <ul> |
|
204 <li class="right" style="margin-right: 10px"> |
|
205 <a href="genindex.html" title="General Index" |
|
206 >index</a></li> |
|
207 <li class="right" > |
|
208 <a href="py-modindex.html" title="Python Module Index" |
|
209 >modules</a> |</li> |
|
210 <li class="right" > |
|
211 <a href="zodb.html" title="Creating ZODB" |
|
212 >next</a> |</li> |
|
213 <li class="nav-item nav-item-0"><a href="#">PyAMS User Guide 0.1.0 documentation</a> »</li> |
|
214 </ul> |
|
215 </div> |
|
216 <div class="footer" role="contentinfo"> |
|
217 © Copyright 2017, Thierry Florac. |
|
218 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.5. |
|
219 </div> |
|
220 </body> |
|
221 </html> |