Mercurial Mercurial > pyams > pyams_user_guide / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
src/build/html/pyams_security.html
changeset 0 d153941bb745 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/build/html/pyams_security.html	Sun Jan 14 11:48:51 2018 +0100
@@ -0,0 +1,1084 @@
+
+<!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>PyAMS security &#8212; 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="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;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&amp;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="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+            
+  <div class="section" id="pyams-security">
+<span id="id1"></span><h1>PyAMS security<a class="headerlink" href="#pyams-security" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="module-pyams_security">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_security" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_security.includeme">
+<code class="descclassname">pyams_security.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.includeme" title="Permalink to this definition">¶</a></dt>
+<dd><p>Pyramid include</p>
+<p>Split in another package to remove cyclic dependencies with TranslationStringFactory</p>
+</dd></dl>
+
+</div>
+<div class="section" id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="pyams_security.interfaces.html">pyams_security.interfaces package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.interfaces.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.interfaces.html#module-pyams_security.interfaces.notification">pyams_security.interfaces.notification module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.interfaces.html#module-pyams_security.interfaces.profile">pyams_security.interfaces.profile module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.interfaces.html#module-pyams_security.interfaces">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_security.plugin.html">pyams_security.plugin package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin.admin">pyams_security.plugin.admin module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin.group">pyams_security.plugin.group module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin.http">pyams_security.plugin.http module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin.social">pyams_security.plugin.social module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin.userfolder">pyams_security.plugin.userfolder module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.plugin.html#module-pyams_security.plugin">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_security.tests.html">pyams_security.tests package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.tests.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.tests.html#module-pyams_security.tests.test_utilsdocs">pyams_security.tests.test_utilsdocs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.tests.html#module-pyams_security.tests.test_utilsdocstrings">pyams_security.tests.test_utilsdocstrings module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.tests.html#module-pyams_security.tests">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_security.views.html">pyams_security.views package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#module-pyams_security.views.login">pyams_security.views.login module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#module-pyams_security.views.oauth">pyams_security.views.oauth module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#module-pyams_security.views.userfolder">pyams_security.views.userfolder module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#module-pyams_security.views.utility">pyams_security.views.utility module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.views.html#module-pyams_security.views">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_security.widget.html">pyams_security.widget package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.widget.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.widget.html#module-pyams_security.widget.interfaces">pyams_security.widget.interfaces module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.widget.html#module-pyams_security.widget">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_security.zmi.html">pyams_security.zmi package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pyams_security.zmi.plugin.html">pyams_security.zmi.plugin package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#submodules">Submodules</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#module-pyams_security.zmi.plugin.admin">pyams_security.zmi.plugin.admin module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#module-pyams_security.zmi.plugin.group">pyams_security.zmi.plugin.group module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#module-pyams_security.zmi.plugin.social">pyams_security.zmi.plugin.social module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#module-pyams_security.zmi.plugin.userfolder">pyams_security.zmi.plugin.userfolder module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.plugin.html#module-pyams_security.zmi.plugin">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="pyams_security.zmi.widget.html">pyams_security.zmi.widget package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="pyams_security.zmi.widget.html#module-pyams_security.zmi.widget">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi.interfaces">pyams_security.zmi.interfaces module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi.notification">pyams_security.zmi.notification module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi.profile">pyams_security.zmi.profile module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi.security">pyams_security.zmi.security module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi.utility">pyams_security.zmi.utility module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_security.zmi.html#module-pyams_security.zmi">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="module-pyams_security.credential">
+<span id="pyams-security-credential-module"></span><h3>pyams_security.credential module<a class="headerlink" href="#module-pyams_security.credential" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.credential.Credentials">
+<em class="property">class </em><code class="descclassname">pyams_security.credential.</code><code class="descname">Credentials</code><span class="sig-paren">(</span><em>prefix</em>, <em>id</em>, <em>**attributes</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.credential.Credentials" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Credentials class</p>
+<dl class="attribute">
+<dt id="pyams_security.credential.Credentials.attributes">
+<code class="descname">attributes</code><a class="headerlink" href="#pyams_security.credential.Credentials.attributes" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.credential.Credentials.id">
+<code class="descname">id</code><a class="headerlink" href="#pyams_security.credential.Credentials.id" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.credential.Credentials.prefix">
+<code class="descname">prefix</code><a class="headerlink" href="#pyams_security.credential.Credentials.prefix" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.include">
+<span id="pyams-security-include-module"></span><h3>pyams_security.include module<a class="headerlink" href="#module-pyams_security.include" title="Permalink to this headline">¶</a></h3>
+<dl class="function">
+<dt id="pyams_security.include.include_package">
+<code class="descclassname">pyams_security.include.</code><code class="descname">include_package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.include.include_package" title="Permalink to this definition">¶</a></dt>
+<dd><p>Pyramid include</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.index">
+<span id="pyams-security-index-module"></span><h3>pyams_security.index module<a class="headerlink" href="#module-pyams_security.index" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.index.PrincipalsRoleIndex">
+<em class="property">class </em><code class="descclassname">pyams_security.index.</code><code class="descname">PrincipalsRoleIndex</code><span class="sig-paren">(</span><em>role_id</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.index.PrincipalsRoleIndex" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">hypatia.keyword.KeywordIndex</span></code></p>
+<p>Principals role index</p>
+<dl class="method">
+<dt id="pyams_security.index.PrincipalsRoleIndex.discriminate">
+<code class="descname">discriminate</code><span class="sig-paren">(</span><em>obj</em>, <em>default</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.index.PrincipalsRoleIndex.discriminate" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.notification">
+<span id="pyams-security-notification-module"></span><h3>pyams_security.notification module<a class="headerlink" href="#module-pyams_security.notification" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.notification.NotificationSettings">
+<em class="property">class </em><code class="descclassname">pyams_security.notification.</code><code class="descname">NotificationSettings</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code></p>
+<p>Notification settings</p>
+<dl class="attribute">
+<dt id="pyams_security.notification.NotificationSettings.enable_notifications">
+<code class="descname">enable_notifications</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.enable_notifications" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.notification.NotificationSettings.mailer">
+<code class="descname">mailer</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.mailer" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.notification.NotificationSettings.sender_email">
+<code class="descname">sender_email</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.sender_email" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.notification.NotificationSettings.sender_name">
+<code class="descname">sender_name</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.sender_name" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.notification.NotificationSettings.service_name">
+<code class="descname">service_name</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.service_name" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.notification.NotificationSettings.service_owner">
+<code class="descname">service_owner</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.service_owner" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.notification.NotificationSettings.signature">
+<code class="descname">signature</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.signature" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.notification.NotificationSettings.subject_prefix">
+<code class="descname">subject_prefix</code><a class="headerlink" href="#pyams_security.notification.NotificationSettings.subject_prefix" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_security.notification.SecurityNotificationSettingsFactory">
+<code class="descclassname">pyams_security.notification.</code><code class="descname">SecurityNotificationSettingsFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.notification.SecurityNotificationSettingsFactory" title="Permalink to this definition">¶</a></dt>
+<dd><p>Security manager notifications factory adapter</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.permission">
+<span id="pyams-security-permission-module"></span><h3>pyams_security.permission module<a class="headerlink" href="#module-pyams_security.permission" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.permission.Permission">
+<em class="property">class </em><code class="descclassname">pyams_security.permission.</code><code class="descname">Permission</code><span class="sig-paren">(</span><em>values=None</em>, <em>**args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.permission.Permission" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Permission utility class</p>
+<dl class="attribute">
+<dt id="pyams_security.permission.Permission.description">
+<code class="descname">description</code><a class="headerlink" href="#pyams_security.permission.Permission.description" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.permission.Permission.id">
+<code class="descname">id</code><a class="headerlink" href="#pyams_security.permission.Permission.id" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.permission.Permission.title">
+<code class="descname">title</code><a class="headerlink" href="#pyams_security.permission.Permission.title" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_security.permission.PermissionsVocabulary">
+<em class="property">class </em><code class="descclassname">pyams_security.permission.</code><code class="descname">PermissionsVocabulary</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.permission.PermissionsVocabulary" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p>
+<p>Permissions vocabulary</p>
+<dl class="attribute">
+<dt id="pyams_security.permission.PermissionsVocabulary.interface">
+<code class="descname">interface</code><em class="property"> = &lt;InterfaceClass pyams_security.interfaces.IPermission&gt;</em><a class="headerlink" href="#pyams_security.permission.PermissionsVocabulary.interface" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_security.permission.register_permission">
+<code class="descclassname">pyams_security.permission.</code><code class="descname">register_permission</code><span class="sig-paren">(</span><em>config</em>, <em>permission</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.permission.register_permission" title="Permalink to this definition">¶</a></dt>
+<dd><p>Register a new permission</p>
+<p>Permissions registry is not required.
+But only registered permissions can be applied via default
+ZMI features</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.principal">
+<span id="pyams-security-principal-module"></span><h3>pyams_security.principal module<a class="headerlink" href="#module-pyams_security.principal" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.principal.MissingPrincipal">
+<em class="property">class </em><code class="descclassname">pyams_security.principal.</code><code class="descname">MissingPrincipal</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.principal.MissingPrincipal" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Missing principal info</p>
+<p>This class can be used when a stored principal ID
+references a principal which can’t be found anymore</p>
+<dl class="attribute">
+<dt id="pyams_security.principal.MissingPrincipal.id">
+<code class="descname">id</code><a class="headerlink" href="#pyams_security.principal.MissingPrincipal.id" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.principal.MissingPrincipal.title">
+<code class="descname">title</code><a class="headerlink" href="#pyams_security.principal.MissingPrincipal.title" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_security.principal.PrincipalInfo">
+<em class="property">class </em><code class="descclassname">pyams_security.principal.</code><code class="descname">PrincipalInfo</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.principal.PrincipalInfo" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Generic principal info</p>
+<dl class="attribute">
+<dt id="pyams_security.principal.PrincipalInfo.attributes">
+<code class="descname">attributes</code><a class="headerlink" href="#pyams_security.principal.PrincipalInfo.attributes" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.principal.PrincipalInfo.id">
+<code class="descname">id</code><a class="headerlink" href="#pyams_security.principal.PrincipalInfo.id" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.principal.PrincipalInfo.title">
+<code class="descname">title</code><a class="headerlink" href="#pyams_security.principal.PrincipalInfo.title" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_security.principal.get_principal_annotations">
+<code class="descclassname">pyams_security.principal.</code><code class="descname">get_principal_annotations</code><span class="sig-paren">(</span><em>principal</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.principal.get_principal_annotations" title="Permalink to this definition">¶</a></dt>
+<dd><p>Principal annotations adapter</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.profile">
+<span id="pyams-security-profile-module"></span><h3>pyams_security.profile module<a class="headerlink" href="#module-pyams_security.profile" title="Permalink to this headline">¶</a></h3>
+<dl class="function">
+<dt id="pyams_security.profile.PrincipalPublicProfileFactory">
+<code class="descclassname">pyams_security.profile.</code><code class="descname">PrincipalPublicProfileFactory</code><span class="sig-paren">(</span><em>principal</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.profile.PrincipalPublicProfileFactory" title="Permalink to this definition">¶</a></dt>
+<dd><p>Principal public profile factory adapter</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_security.profile.ProfileTraverser">
+<em class="property">class </em><code class="descclassname">pyams_security.profile.</code><code class="descname">ProfileTraverser</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.profile.ProfileTraverser" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextRequestAdapter" title="pyams_utils.adapter.ContextRequestAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextRequestAdapter</span></code></a></p>
+<p>++profile++ namespace traverser</p>
+<dl class="method">
+<dt id="pyams_security.profile.ProfileTraverser.traverse">
+<code class="descname">traverse</code><span class="sig-paren">(</span><em>name</em>, <em>furtherpath=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.profile.ProfileTraverser.traverse" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_security.profile.PublicProfile">
+<em class="property">class </em><code class="descclassname">pyams_security.profile.</code><code class="descname">PublicProfile</code><a class="headerlink" href="#pyams_security.profile.PublicProfile" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
+<p>Public profile persistent class</p>
+<dl class="attribute">
+<dt id="pyams_security.profile.PublicProfile.avatar">
+<code class="descname">avatar</code><a class="headerlink" href="#pyams_security.profile.PublicProfile.avatar" title="Permalink to this definition">¶</a></dt>
+<dd><p>Property class used to handle files</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_security.profile.PublicProfileExtension">
+<em class="property">class </em><code class="descclassname">pyams_security.profile.</code><code class="descname">PublicProfileExtension</code><span class="sig-paren">(</span><em>context</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.profile.PublicProfileExtension" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="pyams_utils.html#pyams_utils.adapter.ContextRequestAdapter" title="pyams_utils.adapter.ContextRequestAdapter"><code class="xref py py-class docutils literal"><span class="pre">pyams_utils.adapter.ContextRequestAdapter</span></code></a></p>
+<p>public_profile TALES extension</p>
+<dl class="method">
+<dt id="pyams_security.profile.PublicProfileExtension.render">
+<code class="descname">render</code><span class="sig-paren">(</span><em>request=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.profile.PublicProfileExtension.render" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_security.profile.PublicProfileFactory">
+<code class="descclassname">pyams_security.profile.</code><code class="descname">PublicProfileFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.profile.PublicProfileFactory" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.property">
+<span id="pyams-security-property-module"></span><h3>pyams_security.property module<a class="headerlink" href="#module-pyams_security.property" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.property.RolePrincipalsFieldProperty">
+<em class="property">class </em><code class="descclassname">pyams_security.property.</code><code class="descname">RolePrincipalsFieldProperty</code><span class="sig-paren">(</span><em>field</em>, <em>role_id=None</em>, <em>name=None</em>, <em>**args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.property.RolePrincipalsFieldProperty" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Custom field property used to handle role principals</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.role">
+<span id="pyams-security-role-module"></span><h3>pyams_security.role module<a class="headerlink" href="#module-pyams_security.role" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.role.Role">
+<em class="property">class </em><code class="descclassname">pyams_security.role.</code><code class="descname">Role</code><span class="sig-paren">(</span><em>values=None</em>, <em>**args</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.role.Role" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Role utility class</p>
+<dl class="attribute">
+<dt id="pyams_security.role.Role.description">
+<code class="descname">description</code><a class="headerlink" href="#pyams_security.role.Role.description" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.role.Role.id">
+<code class="descname">id</code><a class="headerlink" href="#pyams_security.role.Role.id" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.role.Role.managers">
+<code class="descname">managers</code><a class="headerlink" href="#pyams_security.role.Role.managers" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.role.Role.permissions">
+<code class="descname">permissions</code><a class="headerlink" href="#pyams_security.role.Role.permissions" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.role.Role.title">
+<code class="descname">title</code><a class="headerlink" href="#pyams_security.role.Role.title" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_security.role.RolesVocabulary">
+<em class="property">class </em><code class="descclassname">pyams_security.role.</code><code class="descname">RolesVocabulary</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.role.RolesVocabulary" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema.vocabulary.SimpleVocabulary</span></code></p>
+<p>Roles vocabulary</p>
+<dl class="attribute">
+<dt id="pyams_security.role.RolesVocabulary.interface">
+<code class="descname">interface</code><em class="property"> = &lt;InterfaceClass pyams_security.interfaces.IRole&gt;</em><a class="headerlink" href="#pyams_security.role.RolesVocabulary.interface" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_security.role.register_role">
+<code class="descclassname">pyams_security.role.</code><code class="descname">register_role</code><span class="sig-paren">(</span><em>config</em>, <em>role</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.role.register_role" title="Permalink to this definition">¶</a></dt>
+<dd><p>Register a new role</p>
+<p>Roles registry is not required.
+But only registered roles can be applied via default
+ZMI features.</p>
+<p>If a role is registered several times, previous registrations
+will just be updated to add new permissions.
+Title and description are not updated after first registration.</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.schema">
+<span id="pyams-security-schema-module"></span><h3>pyams_security.schema module<a class="headerlink" href="#module-pyams_security.schema" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.schema.PermissionField">
+<em class="property">class </em><code class="descclassname">pyams_security.schema.</code><code class="descname">PermissionField</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.schema.PermissionField" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema._field.Choice</span></code></p>
+<p>Permission field</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_security.schema.PermissionsSetField">
+<em class="property">class </em><code class="descclassname">pyams_security.schema.</code><code class="descname">PermissionsSetField</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.schema.PermissionsSetField" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema._field.Set</span></code></p>
+<p>Permissions set field</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_security.schema.Principal">
+<em class="property">class </em><code class="descclassname">pyams_security.schema.</code><code class="descname">Principal</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.schema.Principal" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema._bootstrapfields.TextLine</span></code></p>
+<p>Principal field</p>
+<dl class="attribute">
+<dt id="pyams_security.schema.Principal.role_id">
+<code class="descname">role_id</code><em class="property"> = None</em><a class="headerlink" href="#pyams_security.schema.Principal.role_id" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_security.schema.PrincipalsSet">
+<em class="property">class </em><code class="descclassname">pyams_security.schema.</code><code class="descname">PrincipalsSet</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.schema.PrincipalsSet" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.schema._field.Set</span></code></p>
+<p>Principals set field</p>
+<dl class="attribute">
+<dt id="pyams_security.schema.PrincipalsSet.role_id">
+<code class="descname">role_id</code><em class="property"> = None</em><a class="headerlink" href="#pyams_security.schema.PrincipalsSet.role_id" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.security">
+<span id="pyams-security-security-module"></span><h3>pyams_security.security module<a class="headerlink" href="#module-pyams_security.security" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.security.ProtectedObject">
+<em class="property">class </em><code class="descclassname">pyams_security.security.</code><code class="descname">ProtectedObject</code><a class="headerlink" href="#pyams_security.security.ProtectedObject" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>Base protected object class</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_security.security.ProtectedObjectFactory">
+<code class="descclassname">pyams_security.security.</code><code class="descname">ProtectedObjectFactory</code><span class="sig-paren">(</span><em>context</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.ProtectedObjectFactory" title="Permalink to this definition">¶</a></dt>
+<dd><p>Default protected object factory</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_security.security.RoleProtectedObject">
+<em class="property">class </em><code class="descclassname">pyams_security.security.</code><code class="descname">RoleProtectedObject</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">persistent.Persistent</span></code>, <code class="xref py py-class docutils literal"><span class="pre">zope.container.contained.Contained</span></code></p>
+<p>Base class for object protected by roles</p>
+<dl class="attribute">
+<dt id="pyams_security.security.RoleProtectedObject.authenticated_denied">
+<code class="descname">authenticated_denied</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.authenticated_denied" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.security.RoleProtectedObject.authenticated_granted">
+<code class="descname">authenticated_granted</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.authenticated_granted" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.security.RoleProtectedObject.everyone_denied">
+<code class="descname">everyone_denied</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.everyone_denied" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.security.RoleProtectedObject.everyone_granted">
+<code class="descname">everyone_granted</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.everyone_granted" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.security.RoleProtectedObject.get_authenticated_denied">
+<code class="descname">get_authenticated_denied</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_authenticated_denied" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.security.RoleProtectedObject.get_authenticated_granted">
+<code class="descname">get_authenticated_granted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_authenticated_granted" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.security.RoleProtectedObject.get_everyone_denied">
+<code class="descname">get_everyone_denied</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_everyone_denied" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.security.RoleProtectedObject.get_everyone_granted">
+<code class="descname">get_everyone_granted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_everyone_granted" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.security.RoleProtectedObject.get_granted_roles">
+<code class="descname">get_granted_roles</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_granted_roles" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.security.RoleProtectedObject.get_permissions">
+<code class="descname">get_permissions</code><span class="sig-paren">(</span><em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_permissions" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.security.RoleProtectedObject.get_principals">
+<code class="descname">get_principals</code><span class="sig-paren">(</span><em>role_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_principals" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.security.RoleProtectedObject.get_roles">
+<code class="descname">get_roles</code><span class="sig-paren">(</span><em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.get_roles" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.security.RoleProtectedObject.grant_role">
+<code class="descname">grant_role</code><span class="sig-paren">(</span><em>role_id</em>, <em>principal_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.grant_role" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.security.RoleProtectedObject.inherit_parent_roles">
+<code class="descname">inherit_parent_roles</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.inherit_parent_roles" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.security.RoleProtectedObject.inherit_parent_security">
+<code class="descname">inherit_parent_security</code><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.inherit_parent_security" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.security.RoleProtectedObject.revoke_role">
+<code class="descname">revoke_role</code><span class="sig-paren">(</span><em>role_id</em>, <em>principal_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.security.RoleProtectedObject.revoke_role" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.site">
+<span id="pyams-security-site-module"></span><h3>pyams_security.site module<a class="headerlink" href="#module-pyams_security.site" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.site.SecurityGenerationsChecker">
+<em class="property">class </em><code class="descclassname">pyams_security.site.</code><code class="descname">SecurityGenerationsChecker</code><a class="headerlink" href="#pyams_security.site.SecurityGenerationsChecker" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>I18n generations checker</p>
+<dl class="method">
+<dt id="pyams_security.site.SecurityGenerationsChecker.evolve">
+<code class="descname">evolve</code><span class="sig-paren">(</span><em>site</em>, <em>current=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.site.SecurityGenerationsChecker.evolve" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check for required utilities</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.site.SecurityGenerationsChecker.generation">
+<code class="descname">generation</code><em class="property"> = 1</em><a class="headerlink" href="#pyams_security.site.SecurityGenerationsChecker.generation" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_security.site.get_admin_user">
+<code class="descclassname">pyams_security.site.</code><code class="descname">get_admin_user</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.site.get_admin_user" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get system manager profile</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_security.site.get_service_user">
+<code class="descclassname">pyams_security.site.</code><code class="descname">get_service_user</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.site.get_service_user" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get internal services profile</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_security.site.handle_new_local_site">
+<code class="descclassname">pyams_security.site.</code><code class="descname">handle_new_local_site</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.site.handle_new_local_site" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a new security manager when a site is created</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_security.site.handle_new_security_manager">
+<code class="descclassname">pyams_security.site.</code><code class="descname">handle_new_security_manager</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.site.handle_new_security_manager" title="Permalink to this definition">¶</a></dt>
+<dd><p>Automatically create a new administration login</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.utility">
+<span id="pyams-security-utility-module"></span><h3>pyams_security.utility module<a class="headerlink" href="#module-pyams_security.utility" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.utility.PyAMSAuthenticationPolicy">
+<em class="property">class </em><code class="descclassname">pyams_security.utility.</code><code class="descname">PyAMSAuthenticationPolicy</code><span class="sig-paren">(</span><em>secret</em>, <em>credentials=('http'</em>, <em>)</em>, <em>cookie_name='auth_ticket'</em>, <em>secure=False</em>, <em>include_ip=False</em>, <em>timeout=None</em>, <em>reissue_time=None</em>, <em>max_age=None</em>, <em>path='/'</em>, <em>http_only=False</em>, <em>wild_domain=True</em>, <em>hashalg='sha256'</em>, <em>parent_domain=False</em>, <em>domain=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
+<p>PyAMS authentication policy</p>
+<p>This authentication policy relies on a registered ISecurityManager utility.
+Use same authentication ticket as AuthTktAuthenticationPolicy.</p>
+<p><code class="docutils literal"><span class="pre">credentials</span></code> is the list of credentials extraction utilities which can be
+used to get credentials.</p>
+<p>See <cite>pyramid.authentication.AuthTktAuthenticationPolicy</cite> to get description
+of other constructor arguments.</p>
+<dl class="method">
+<dt id="pyams_security.utility.PyAMSAuthenticationPolicy.authenticated_userid">
+<code class="descname">authenticated_userid</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.authenticated_userid" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.utility.PyAMSAuthenticationPolicy.credentials_plugins">
+<code class="descname">credentials_plugins</code><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.credentials_plugins" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.PyAMSAuthenticationPolicy.effective_principals">
+<code class="descname">effective_principals</code><span class="sig-paren">(</span><em>x</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.effective_principals" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.PyAMSAuthenticationPolicy.forget">
+<code class="descname">forget</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.forget" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.PyAMSAuthenticationPolicy.remember">
+<code class="descname">remember</code><span class="sig-paren">(</span><em>request</em>, <em>principal</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.remember" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.PyAMSAuthenticationPolicy.unauthenticated_userid">
+<code class="descname">unauthenticated_userid</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.PyAMSAuthenticationPolicy.unauthenticated_userid" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_security.utility.SecurityManager">
+<em class="property">class </em><code class="descclassname">pyams_security.utility.</code><code class="descname">SecurityManager</code><a class="headerlink" href="#pyams_security.utility.SecurityManager" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.container.folder.Folder</span></code></p>
+<p>Security manager utility</p>
+<dl class="method">
+<dt id="pyams_security.utility.SecurityManager.authenticate">
+<code class="descname">authenticate</code><span class="sig-paren">(</span><em>credentials</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.authenticate" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.SecurityManager.authenticated_userid">
+<code class="descname">authenticated_userid</code><span class="sig-paren">(</span><em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.authenticated_userid" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.utility.SecurityManager.authentication_plugins_names">
+<code class="descname">authentication_plugins_names</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.authentication_plugins_names" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.utility.SecurityManager.authomatic_secret">
+<code class="descname">authomatic_secret</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.authomatic_secret" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.utility.SecurityManager.credentials_plugins_names">
+<code class="descname">credentials_plugins_names</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.credentials_plugins_names" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.utility.SecurityManager.directory_plugins_names">
+<code class="descname">directory_plugins_names</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.directory_plugins_names" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.SecurityManager.effective_principals">
+<code class="descname">effective_principals</code><span class="sig-paren">(</span><em>principal_id</em>, <em>request=None</em>, <em>context=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.effective_principals" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.utility.SecurityManager.enable_social_login">
+<code class="descname">enable_social_login</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.enable_social_login" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.SecurityManager.extract_credentials">
+<code class="descname">extract_credentials</code><span class="sig-paren">(</span><em>request</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.extract_credentials" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.SecurityManager.find_principals">
+<code class="descname">find_principals</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.find_principals" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.SecurityManager.get_all_principals">
+<code class="descname">get_all_principals</code><span class="sig-paren">(</span><em>principal_id</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_all_principals" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.SecurityManager.get_authentication_plugins">
+<code class="descname">get_authentication_plugins</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_authentication_plugins" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.SecurityManager.get_credentials_plugins">
+<code class="descname">get_credentials_plugins</code><span class="sig-paren">(</span><em>request=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_credentials_plugins" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.SecurityManager.get_directory_plugins">
+<code class="descname">get_directory_plugins</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_directory_plugins" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.SecurityManager.get_groups_directory_plugins">
+<code class="descname">get_groups_directory_plugins</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_groups_directory_plugins" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_security.utility.SecurityManager.get_plugin">
+<code class="descname">get_plugin</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_plugin" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.utility.SecurityManager.get_principal">
+<code class="descname">get_principal</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.get_principal" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.utility.SecurityManager.open_registration">
+<code class="descname">open_registration</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.open_registration" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.utility.SecurityManager.social_login_use_popup">
+<code class="descname">social_login_use_popup</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.social_login_use_popup" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.utility.SecurityManager.social_users_folder">
+<code class="descname">social_users_folder</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.social_users_folder" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.utility.SecurityManager.users_folder">
+<code class="descname">users_folder</code><a class="headerlink" href="#pyams_security.utility.SecurityManager.users_folder" title="Permalink to this definition">¶</a></dt>
+<dd><p>Computed attributes based on schema fields</p>
+<p>Field properties provide default values, data validation and error messages
+based on data found in field meta-data.</p>
+<p>Note that FieldProperties cannot be used with slots. They can only
+be used for attributes stored in instance dictionaries.</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_security.utility.get_principal">
+<code class="descclassname">pyams_security.utility.</code><code class="descname">get_principal</code><span class="sig-paren">(</span><em>request</em>, <em>principal_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.utility.get_principal" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get principal associated with given request</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_security.vocabulary">
+<span id="pyams-security-vocabulary-module"></span><h3>pyams_security.vocabulary module<a class="headerlink" href="#module-pyams_security.vocabulary" title="Permalink to this headline">¶</a></h3>
+<dl class="class">
+<dt id="pyams_security.vocabulary.PasswordManagerVocabulary">
+<em class="property">class </em><code class="descclassname">pyams_security.vocabulary.</code><code class="descname">PasswordManagerVocabulary</code><span class="sig-paren">(</span><em>context</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_security.vocabulary.PasswordManagerVocabulary" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">zope.componentvocabulary.vocabulary.UtilityVocabulary</span></code></p>
+<p>Password managers vocabulary</p>
+<dl class="attribute">
+<dt id="pyams_security.vocabulary.PasswordManagerVocabulary.interface">
+<code class="descname">interface</code><em class="property"> = &lt;InterfaceClass zope.password.interfaces.IPasswordManager&gt;</em><a class="headerlink" href="#pyams_security.vocabulary.PasswordManagerVocabulary.interface" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_security.vocabulary.PasswordManagerVocabulary.nameOnly">
+<code class="descname">nameOnly</code><em class="property"> = True</em><a class="headerlink" href="#pyams_security.vocabulary.PasswordManagerVocabulary.nameOnly" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <h3><a href="index.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">PyAMS security</a><ul>
+<li><a class="reference internal" href="#module-pyams_security">Module contents</a></li>
+<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a><ul>
+<li><a class="reference internal" href="#module-pyams_security.credential">pyams_security.credential module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.include">pyams_security.include module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.index">pyams_security.index module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.notification">pyams_security.notification module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.permission">pyams_security.permission module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.principal">pyams_security.principal module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.profile">pyams_security.profile module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.property">pyams_security.property module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.role">pyams_security.role module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.schema">pyams_security.schema module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.security">pyams_security.security module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.site">pyams_security.site module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.utility">pyams_security.utility module</a></li>
+<li><a class="reference internal" href="#module-pyams_security.vocabulary">pyams_security.vocabulary module</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+<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="nav-item nav-item-0"><a href="index.html">PyAMS User Guide 0.1.0 documentation</a> &#187;</li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; 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
pyams/pyams_user_guide