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_catalog.html
changeset 0 d153941bb745 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/build/html/pyams_catalog.html	Sun Jan 14 11:48:51 2018 +0100
@@ -0,0 +1,406 @@
+
+<!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_catalog package &#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-catalog-package">
+<h1>pyams_catalog package<a class="headerlink" href="#pyams-catalog-package" title="Permalink to this headline">¶</a></h1>
+<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_catalog.interfaces.html">pyams_catalog.interfaces package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_catalog.interfaces.html#module-pyams_catalog.interfaces">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_catalog.tests.html">pyams_catalog.tests package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_catalog.tests.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_catalog.tests.html#module-pyams_catalog.tests.test_utilsdocs">pyams_catalog.tests.test_utilsdocs module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_catalog.tests.html#module-pyams_catalog.tests.test_utilsdocstrings">pyams_catalog.tests.test_utilsdocstrings module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_catalog.tests.html#module-pyams_catalog.tests">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="pyams_catalog.zmi.html">pyams_catalog.zmi package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="pyams_catalog.zmi.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_catalog.zmi.html#module-pyams_catalog.zmi.catalog">pyams_catalog.zmi.catalog module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="pyams_catalog.zmi.html#module-pyams_catalog.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>
+<div class="section" id="module-pyams_catalog.include">
+<span id="pyams-catalog-include-module"></span><h2>pyams_catalog.include module<a class="headerlink" href="#module-pyams_catalog.include" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_catalog.include.include_package">
+<code class="descclassname">pyams_catalog.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_catalog.include.include_package" title="Permalink to this definition">¶</a></dt>
+<dd><p>Pyramid include</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_catalog.index">
+<span id="pyams-catalog-index-module"></span><h2>pyams_catalog.index module<a class="headerlink" href="#module-pyams_catalog.index" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_catalog.index.DatetimeIndexWithInterface">
+<em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">DatetimeIndexWithInterface</code><span class="sig-paren">(</span><em>interface</em>, <em>discriminator</em>, <em>resolution=2</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.DatetimeIndexWithInterface" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#pyams_catalog.index.FieldIndexWithInterface" title="pyams_catalog.index.FieldIndexWithInterface"><code class="xref py py-class docutils literal"><span class="pre">pyams_catalog.index.FieldIndexWithInterface</span></code></a></p>
+<p>Normalized datetime index with interface support</p>
+<dl class="method">
+<dt id="pyams_catalog.index.DatetimeIndexWithInterface.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_catalog.index.DatetimeIndexWithInterface.discriminate" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_catalog.index.FacetIndexWithInterface">
+<em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">FacetIndexWithInterface</code><span class="sig-paren">(</span><em>interface</em>, <em>discriminator</em>, <em>facets</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.FacetIndexWithInterface" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#pyams_catalog.index.InterfaceSupportIndexMixin" title="pyams_catalog.index.InterfaceSupportIndexMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_catalog.index.InterfaceSupportIndexMixin</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">hypatia.facet.FacetIndex</span></code></p>
+<p>Facet index with interface support</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_catalog.index.FieldIndexWithInterface">
+<em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">FieldIndexWithInterface</code><span class="sig-paren">(</span><em>interface</em>, <em>discriminator</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.FieldIndexWithInterface" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#pyams_catalog.index.InterfaceSupportIndexMixin" title="pyams_catalog.index.InterfaceSupportIndexMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_catalog.index.InterfaceSupportIndexMixin</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">hypatia.field.FieldIndex</span></code></p>
+<p>Field index with interface support</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_catalog.index.InterfaceSupportIndexMixin">
+<em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">InterfaceSupportIndexMixin</code><span class="sig-paren">(</span><em>interface</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.InterfaceSupportIndexMixin" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">hypatia.util.BaseIndexMixin</span></code></p>
+<p>Custom index mixin handling objects interfaces</p>
+<dl class="method">
+<dt id="pyams_catalog.index.InterfaceSupportIndexMixin.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_catalog.index.InterfaceSupportIndexMixin.discriminate" title="Permalink to this definition">¶</a></dt>
+<dd><p>See interface IIndexInjection</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_catalog.index.KeywordIndexWithInterface">
+<em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">KeywordIndexWithInterface</code><span class="sig-paren">(</span><em>interface</em>, <em>discriminator</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.KeywordIndexWithInterface" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#pyams_catalog.index.InterfaceSupportIndexMixin" title="pyams_catalog.index.InterfaceSupportIndexMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_catalog.index.InterfaceSupportIndexMixin</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">hypatia.keyword.KeywordIndex</span></code></p>
+<p>Keyword index with interface support</p>
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_catalog.index.TextIndexWithInterface">
+<em class="property">class </em><code class="descclassname">pyams_catalog.index.</code><code class="descname">TextIndexWithInterface</code><span class="sig-paren">(</span><em>interface</em>, <em>discriminator</em>, <em>lexicon=None</em>, <em>language='english'</em>, <em>index=None</em>, <em>family=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.TextIndexWithInterface" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference internal" href="#pyams_catalog.index.InterfaceSupportIndexMixin" title="pyams_catalog.index.InterfaceSupportIndexMixin"><code class="xref py py-class docutils literal"><span class="pre">pyams_catalog.index.InterfaceSupportIndexMixin</span></code></a>, <code class="xref py py-class docutils literal"><span class="pre">hypatia.text.TextIndex</span></code></p>
+<p>Text index with interface support</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_catalog.index.get_resolution">
+<code class="descclassname">pyams_catalog.index.</code><code class="descname">get_resolution</code><span class="sig-paren">(</span><em>value</em>, <em>resolution</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.index.get_resolution" title="Permalink to this definition">¶</a></dt>
+<dd><p>Set resolution of given date or datetime</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">pyams_catalog.interfaces</span> <span class="k">import</span> <span class="o">*</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">pyams_catalog.index</span> <span class="k">import</span> <span class="n">get_resolution</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">date</span><span class="p">,</span> <span class="n">datetime</span>
+</pre></div>
+</div>
+<p>Starting with dates:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">today</span> <span class="o">=</span> <span class="n">date</span><span class="p">(</span><span class="mi">2017</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">11</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">today</span><span class="p">,</span> <span class="n">YEAR_RESOLUTION</span><span class="p">)</span>
+<span class="go">datetime.date(2017, 1, 1)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">today</span><span class="p">,</span> <span class="n">MONTH_RESOLUTION</span><span class="p">)</span>
+<span class="go">datetime.date(2017, 7, 1)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">today</span><span class="p">,</span> <span class="n">DATE_RESOLUTION</span><span class="p">)</span>
+<span class="go">datetime.date(2017, 7, 11)</span>
+</pre></div>
+</div>
+<p>Asking for a resolution higher than DATE with a date input only returns date:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">today</span><span class="p">,</span> <span class="n">MINUTE_RESOLUTION</span><span class="p">)</span>
+<span class="go">datetime.date(2017, 7, 11)</span>
+</pre></div>
+</div>
+<p>Same examples with datetimes:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">now</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2017</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">11</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">22</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">YEAR_RESOLUTION</span><span class="p">)</span>
+<span class="go">datetime.datetime(2017, 1, 1, 0, 0)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">MONTH_RESOLUTION</span><span class="p">)</span>
+<span class="go">datetime.datetime(2017, 7, 1, 0, 0)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">DATE_RESOLUTION</span><span class="p">)</span>
+<span class="go">datetime.datetime(2017, 7, 11, 0, 0)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">HOUR_RESOLUTION</span><span class="p">)</span>
+<span class="go">datetime.datetime(2017, 7, 11, 13, 0)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">MINUTE_RESOLUTION</span><span class="p">)</span>
+<span class="go">datetime.datetime(2017, 7, 11, 13, 22)</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">get_resolution</span><span class="p">(</span><span class="n">now</span><span class="p">,</span> <span class="n">SECOND_RESOLUTION</span><span class="p">)</span>
+<span class="go">datetime.datetime(2017, 7, 11, 13, 22, 10)</span>
+</pre></div>
+</div>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_catalog.nltk">
+<span id="pyams-catalog-nltk-module"></span><h2>pyams_catalog.nltk module<a class="headerlink" href="#module-pyams_catalog.nltk" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_catalog.nltk.NltkFullTextProcessor">
+<em class="property">class </em><code class="descclassname">pyams_catalog.nltk.</code><code class="descname">NltkFullTextProcessor</code><span class="sig-paren">(</span><em>language='english'</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkFullTextProcessor" 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>NLTK based full text processor</p>
+<dl class="method">
+<dt id="pyams_catalog.nltk.NltkFullTextProcessor.process">
+<code class="descname">process</code><span class="sig-paren">(</span><em>lst</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkFullTextProcessor.process" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_catalog.nltk.NltkFullTextProcessor.processGlob">
+<code class="descname">processGlob</code><span class="sig-paren">(</span><em>lst</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkFullTextProcessor.processGlob" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="pyams_catalog.nltk.NltkStemmedTextProcessor">
+<em class="property">class </em><code class="descclassname">pyams_catalog.nltk.</code><code class="descname">NltkStemmedTextProcessor</code><span class="sig-paren">(</span><em>language='english'</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkStemmedTextProcessor" 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>NLTK based text processor using stemmer</p>
+<dl class="method">
+<dt id="pyams_catalog.nltk.NltkStemmedTextProcessor.process">
+<code class="descname">process</code><span class="sig-paren">(</span><em>lst</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkStemmedTextProcessor.process" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_catalog.nltk.NltkStemmedTextProcessor.processGlob">
+<code class="descname">processGlob</code><span class="sig-paren">(</span><em>lst</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.nltk.NltkStemmedTextProcessor.processGlob" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_catalog.query">
+<span id="pyams-catalog-query-module"></span><h2>pyams_catalog.query module<a class="headerlink" href="#module-pyams_catalog.query" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_catalog.query.CatalogResultSet">
+<em class="property">class </em><code class="descclassname">pyams_catalog.query.</code><code class="descname">CatalogResultSet</code><span class="sig-paren">(</span><em>query</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.query.CatalogResultSet" 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>Catalog query result set wrapper</p>
+<dl class="method">
+<dt id="pyams_catalog.query.CatalogResultSet.append">
+<code class="descname">append</code><span class="sig-paren">(</span><em>items</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.query.CatalogResultSet.append" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="method">
+<dt id="pyams_catalog.query.CatalogResultSet.prepend">
+<code class="descname">prepend</code><span class="sig-paren">(</span><em>items</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.query.CatalogResultSet.prepend" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_catalog.query.and_">
+<code class="descclassname">pyams_catalog.query.</code><code class="descname">and_</code><span class="sig-paren">(</span><em>source</em>, <em>added</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.query.and_" title="Permalink to this definition">¶</a></dt>
+<dd><p>Combine two queries with ‘and’</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_catalog.query.or_">
+<code class="descclassname">pyams_catalog.query.</code><code class="descname">or_</code><span class="sig-paren">(</span><em>source</em>, <em>added</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.query.or_" title="Permalink to this definition">¶</a></dt>
+<dd><p>Combine two queries with ‘or’</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_catalog.site">
+<span id="pyams-catalog-site-module"></span><h2>pyams_catalog.site module<a class="headerlink" href="#module-pyams_catalog.site" title="Permalink to this headline">¶</a></h2>
+<dl class="class">
+<dt id="pyams_catalog.site.CatalogGenerationsChecker">
+<em class="property">class </em><code class="descclassname">pyams_catalog.site.</code><code class="descname">CatalogGenerationsChecker</code><a class="headerlink" href="#pyams_catalog.site.CatalogGenerationsChecker" 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>Catalog generations checker</p>
+<dl class="method">
+<dt id="pyams_catalog.site.CatalogGenerationsChecker.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_catalog.site.CatalogGenerationsChecker.evolve" title="Permalink to this definition">¶</a></dt>
+<dd><p>Check for required utilities</p>
+</dd></dl>
+
+<dl class="attribute">
+<dt id="pyams_catalog.site.CatalogGenerationsChecker.generation">
+<code class="descname">generation</code><em class="property"> = 1</em><a class="headerlink" href="#pyams_catalog.site.CatalogGenerationsChecker.generation" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_catalog.site.check_required_indexes">
+<code class="descclassname">pyams_catalog.site.</code><code class="descname">check_required_indexes</code><span class="sig-paren">(</span><em>site</em>, <em>indexes</em>, <em>catalog_name=''</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.site.check_required_indexes" title="Permalink to this definition">¶</a></dt>
+<dd><p>Utility function to check for required catalog indexes</p>
+<p>utilities argument is a tuple made of:
+- the index name
+- the index class
+- index factory arguments</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_catalog.site.handle_modified_object">
+<code class="descclassname">pyams_catalog.site.</code><code class="descname">handle_modified_object</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.site.handle_modified_object" title="Permalink to this definition">¶</a></dt>
+<dd><p>Update catalog for modified object</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_catalog.site.handle_new_local_site">
+<code class="descclassname">pyams_catalog.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_catalog.site.handle_new_local_site" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a new catalog when a site is created</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_catalog.site.handle_new_object">
+<code class="descclassname">pyams_catalog.site.</code><code class="descname">handle_new_object</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.site.handle_new_object" title="Permalink to this definition">¶</a></dt>
+<dd><p>Index new persistent object</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_catalog.site.handle_removed_object">
+<code class="descclassname">pyams_catalog.site.</code><code class="descname">handle_removed_object</code><span class="sig-paren">(</span><em>event</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.site.handle_removed_object" title="Permalink to this definition">¶</a></dt>
+<dd><p>Un-index removed object</p>
+<p>Don’t use IObjectRemovedEvent to avoid objects from being already unregistered
+from IIntId utility!!!</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_catalog.utils">
+<span id="pyams-catalog-utils-module"></span><h2>pyams_catalog.utils module<a class="headerlink" href="#module-pyams_catalog.utils" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_catalog.utils.catalog_key_adapter">
+<code class="descclassname">pyams_catalog.utils.</code><code class="descname">catalog_key_adapter</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.utils.catalog_key_adapter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Catalog key value adapter</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_catalog.utils.index_object">
+<code class="descclassname">pyams_catalog.utils.</code><code class="descname">index_object</code><span class="sig-paren">(</span><em>obj</em>, <em>catalog=''</em>, <em>ignore_notyet=False</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.utils.index_object" title="Permalink to this definition">¶</a></dt>
+<dd><p>Index given object into catalog</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_catalog.utils.reindex_object">
+<code class="descclassname">pyams_catalog.utils.</code><code class="descname">reindex_object</code><span class="sig-paren">(</span><em>obj</em>, <em>catalog=''</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.utils.reindex_object" title="Permalink to this definition">¶</a></dt>
+<dd><p>Reindex given object into catalog</p>
+</dd></dl>
+
+<dl class="function">
+<dt id="pyams_catalog.utils.unindex_object">
+<code class="descclassname">pyams_catalog.utils.</code><code class="descname">unindex_object</code><span class="sig-paren">(</span><em>obj</em>, <em>catalog=''</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.utils.unindex_object" title="Permalink to this definition">¶</a></dt>
+<dd><p>Unindex given object from catalog</p>
+</dd></dl>
+
+</div>
+<div class="section" id="module-pyams_catalog">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyams_catalog" title="Permalink to this headline">¶</a></h2>
+<dl class="function">
+<dt id="pyams_catalog.includeme">
+<code class="descclassname">pyams_catalog.</code><code class="descname">includeme</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#pyams_catalog.includeme" title="Permalink to this definition">¶</a></dt>
+<dd><p>Pyramid include</p>
+</dd></dl>
+
+</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_catalog package</a><ul>
+<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#submodules">Submodules</a></li>
+<li><a class="reference internal" href="#module-pyams_catalog.include">pyams_catalog.include module</a></li>
+<li><a class="reference internal" href="#module-pyams_catalog.index">pyams_catalog.index module</a></li>
+<li><a class="reference internal" href="#module-pyams_catalog.nltk">pyams_catalog.nltk module</a></li>
+<li><a class="reference internal" href="#module-pyams_catalog.query">pyams_catalog.query module</a></li>
+<li><a class="reference internal" href="#module-pyams_catalog.site">pyams_catalog.site module</a></li>
+<li><a class="reference internal" href="#module-pyams_catalog.utils">pyams_catalog.utils module</a></li>
+<li><a class="reference internal" href="#module-pyams_catalog">Module contents</a></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