3.7.1 - Add pypy documentation

_modules/index.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Overview: module code &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>Overview: module code &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -177,7 +177,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

_modules/parsedmarc.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>parsedmarc &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>parsedmarc &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -188,7 +188,7 @@
 <span class="kn">import</span> <span class="nn">dateparser</span>
 <span class="kn">import</span> <span class="nn">mailparser</span>
 
-<span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;3.7.1&quot;</span>
+<span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;3.7.2&quot;</span>
 
 <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
 <span class="n">logger</span><span class="o">.</span><span class="n">setLevel</span><span class="p">(</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span>
@@ -1627,7 +1627,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

_modules/parsedmarc/elastic.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>parsedmarc.elastic &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>parsedmarc.elastic &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -151,7 +151,7 @@
 
 <span class="kn">import</span> <span class="nn">parsedmarc</span>
 <span class="kn">from</span> <span class="nn">elasticsearch_dsl.search</span> <span class="k">import</span> <span class="n">Q</span>
-<span class="kn">from</span> <span class="nn">elasticsearch_dsl</span> <span class="k">import</span> <span class="n">connections</span><span class="p">,</span> <span class="n">Object</span><span class="p">,</span> <span class="n">DocType</span><span class="p">,</span> <span class="n">Index</span><span class="p">,</span> <span class="n">Nested</span><span class="p">,</span> \
+<span class="kn">from</span> <span class="nn">elasticsearch_dsl</span> <span class="k">import</span> <span class="n">connections</span><span class="p">,</span> <span class="n">Object</span><span class="p">,</span> <span class="n">Document</span><span class="p">,</span> <span class="n">Index</span><span class="p">,</span> <span class="n">Nested</span><span class="p">,</span> \
     <span class="n">InnerDoc</span><span class="p">,</span> <span class="n">Integer</span><span class="p">,</span> <span class="n">Text</span><span class="p">,</span> <span class="n">Boolean</span><span class="p">,</span> <span class="n">DateRange</span><span class="p">,</span> <span class="n">Ip</span><span class="p">,</span> <span class="n">Date</span>
 
 <span class="n">aggregate_index</span> <span class="o">=</span> <span class="n">Index</span><span class="p">(</span><span class="s2">&quot;dmarc_aggregate&quot;</span><span class="p">)</span>
@@ -184,7 +184,7 @@
     <span class="n">results</span> <span class="o">=</span> <span class="n">Text</span><span class="p">()</span>
 
 
-<span class="k">class</span> <span class="nc">_AggregateReportDoc</span><span class="p">(</span><span class="n">DocType</span><span class="p">):</span>
+<span class="k">class</span> <span class="nc">_AggregateReportDoc</span><span class="p">(</span><span class="n">Document</span><span class="p">):</span>
     <span class="k">class</span> <span class="nc">Index</span><span class="p">:</span>
         <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;dmarc_aggregate&quot;</span>
 
@@ -239,7 +239,7 @@
     <span class="n">address</span> <span class="o">=</span> <span class="n">Text</span><span class="p">()</span>
 
 
-<span class="k">class</span> <span class="nc">_EmailAttachmentDoc</span><span class="p">(</span><span class="n">DocType</span><span class="p">):</span>
+<span class="k">class</span> <span class="nc">_EmailAttachmentDoc</span><span class="p">(</span><span class="n">Document</span><span class="p">):</span>
     <span class="n">filename</span> <span class="o">=</span> <span class="n">Text</span><span class="p">()</span>
     <span class="n">content_type</span> <span class="o">=</span> <span class="n">Text</span><span class="p">()</span>
 
@@ -280,7 +280,7 @@
                                 <span class="n">content_type</span><span class="o">=</span><span class="n">content_type</span><span class="p">)</span>
 
 
-<span class="k">class</span> <span class="nc">_ForensicReportDoc</span><span class="p">(</span><span class="n">DocType</span><span class="p">):</span>
+<span class="k">class</span> <span class="nc">_ForensicReportDoc</span><span class="p">(</span><span class="n">Document</span><span class="p">):</span>
     <span class="k">class</span> <span class="nc">Index</span><span class="p">:</span>
         <span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;dmarc_forensic&quot;</span>
 
@@ -545,7 +545,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

_sources/index.rst.txt

@@ -249,6 +249,57 @@ Or, install the latest development release directly from GitHub:
     substitute ``pip`` as an administrator in place of ``sudo pip3``, in the
     above commands.
 
+
+Installation using pypy3
+------------------------
+
+For the best possible processing speed, consider using `parsedmarc` inside a ``pypy3``
+virtualenv. First, `download the latest version of pypy3`_. Extract it to
+``/opt/pypy3`` (``sudo mkdir /opt`` if ``/opt`` does not exist), then create a
+symlink:
+
+.. code-block:: bash
+
+    $ sudo ln -s /opt/pypy3/bin/pypy3 /usr/local/bin/pypy3
+
+Install ``virtualenv`` on your system:
+
+.. code-block:: bash
+
+    $ sudo apt-get install python3-pip
+    $ sudo -H pip3 install -U virtualenv
+
+Uninstall any instance of ``parsedmarc`` that you may have installed globally
+
+.. code-block:: bash
+
+    $ sudo -H pip3 uninstall -y parsedmarc
+
+Next, create a ``pypy3`` virtualenv for parsedmarc
+
+
+.. code-block:: bash
+
+    $ sudo mkdir /opt/venvs
+    $ cd /opt/venvs
+    $ sudo -H pip3 install -U virtualenv
+    $ sudo virtualenv --download -p /usr/local/bin/pypy3 parsedmarc
+    $ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U parsedmarc
+    $ sudo ln -s /opt/venvs/parsedmarc/bin/parsedmarc /usr/local/bin/parsedmarc
+
+To upgrade ``parsedmarc`` inside the virtualenv, run:
+
+
+.. code-block:: bash
+
+    $ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U parsedmarc
+
+Or, install the latest development release directly from GitHub:
+
+.. code-block:: bash
+
+    $ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U git+https://github.com/domainaware/parsedmarc.git
+
 Optional dependencies
 ---------------------
 
@@ -549,6 +600,16 @@ Use this command to check the status of the service:
 
     sudo service parsedmarc status
 
+.. warning::
+
+    Always restart the service every time you upgrade to a new version of
+    ``parsedmarc``:
+
+   .. code-block:: bash
+
+       sudo service parsedmarc restart
+
+
 Using the Kibana dashboards
 ===========================
 
@@ -720,6 +781,8 @@ Indices and tables
 
 .. _Demystifying DMARC: https://seanthegeek.net/459/demystifying-dmarc/
 
+.. _download the latest version of pypy3: https://pypy.org/download.html#default-with-a-jit-compiler
+
 .. _X-Pack: https://www.elastic.co/products/x-pack
 
 .. _kibana_saved_objects.json: https://raw.githubusercontent.com/domainaware/parsedmarc/master/kibana/kibana_saved_objects.json

_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '3.7.1',
+    VERSION: '3.7.2',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

genindex.html

@@ -9,7 +9,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Index &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>Index &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -310,7 +310,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

index.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Welcome to parsedmarc’s documentation! &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>Welcome to parsedmarc’s documentation! &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -95,6 +95,7 @@
 <li><a class="reference internal" href="#sample-forensic-report-output">Sample forensic report output</a></li>
 <li><a class="reference internal" href="#bug-reports">Bug reports</a></li>
 <li><a class="reference internal" href="#installation">Installation</a><ul>
+<li><a class="reference internal" href="#installation-using-pypy3">Installation using pypy3</a></li>
 <li><a class="reference internal" href="#optional-dependencies">Optional dependencies</a></li>
 <li><a class="reference internal" href="#elasticsearch-and-kibana">Elasticsearch and Kibana</a></li>
 <li><a class="reference internal" href="#running-parsedmarc-as-a-systemd-service">Running parsedmarc as a systemd service</a></li>
@@ -395,6 +396,42 @@ macOS or Linux, run</p>
 substitute <code class="docutils literal notranslate"><span class="pre">pip</span></code> as an administrator in place of <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">pip3</span></code>, in the
 above commands.</p>
 </div>
+<div class="section" id="installation-using-pypy3">
+<h3>Installation using pypy3<a class="headerlink" href="#installation-using-pypy3" title="Permalink to this headline">¶</a></h3>
+<p>For the best possible processing speed, consider using <cite>parsedmarc</cite> inside a <code class="docutils literal notranslate"><span class="pre">pypy3</span></code>
+virtualenv. First, <a class="reference external" href="https://pypy.org/download.html#default-with-a-jit-compiler">download the latest version of pypy3</a>. Extract it to
+<code class="docutils literal notranslate"><span class="pre">/opt/pypy3</span></code> (<code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">mkdir</span> <span class="pre">/opt</span></code> if <code class="docutils literal notranslate"><span class="pre">/opt</span></code> does not exist), then create a
+symlink:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo ln -s /opt/pypy3/bin/pypy3 /usr/local/bin/pypy3
+</pre></div>
+</div>
+<p>Install <code class="docutils literal notranslate"><span class="pre">virtualenv</span></code> on your system:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo apt-get install python3-pip
+$ sudo -H pip3 install -U virtualenv
+</pre></div>
+</div>
+<p>Uninstall any instance of <code class="docutils literal notranslate"><span class="pre">parsedmarc</span></code> that you may have installed globally</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo -H pip3 uninstall -y parsedmarc
+</pre></div>
+</div>
+<p>Next, create a <code class="docutils literal notranslate"><span class="pre">pypy3</span></code> virtualenv for parsedmarc</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo mkdir /opt/venvs
+$ <span class="nb">cd</span> /opt/venvs
+$ sudo -H pip3 install -U virtualenv
+$ sudo virtualenv --download -p /usr/local/bin/pypy3 parsedmarc
+$ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U parsedmarc
+$ sudo ln -s /opt/venvs/parsedmarc/bin/parsedmarc /usr/local/bin/parsedmarc
+</pre></div>
+</div>
+<p>To upgrade <code class="docutils literal notranslate"><span class="pre">parsedmarc</span></code> inside the virtualenv, run:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U parsedmarc
+</pre></div>
+</div>
+<p>Or, install the latest development release directly from GitHub:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ sudo -H /opt/venvs/parsedmarc/bin/pip3 install -U git+https://github.com/domainaware/parsedmarc.git
+</pre></div>
+</div>
+</div>
 <div class="section" id="optional-dependencies">
 <h3>Optional dependencies<a class="headerlink" href="#optional-dependencies" title="Permalink to this headline">¶</a></h3>
 <p>If you would like to be able to parse emails saved from Microsoft Outlook
@@ -610,6 +647,15 @@ sudo service parsedmarc restart
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo service parsedmarc status
 </pre></div>
 </div>
+<div class="admonition warning">
+<p class="first admonition-title">Warning</p>
+<blockquote>
+<div>Always restart the service every time you upgrade to a new version of
+<code class="docutils literal notranslate"><span class="pre">parsedmarc</span></code>:</div></blockquote>
+<div class="last highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo service parsedmarc restart
+</pre></div>
+</div>
+</div>
 </div>
 </div>
 <div class="section" id="using-the-kibana-dashboards">
@@ -1244,7 +1290,7 @@ to a callback function</p>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

objects.inv

@@ -1,5 +1,5 @@
 # Sphinx inventory version 2
 # Project: parsedmarc
-# Version: 3.7.1
+# Version: 3.7.2
 # The remainder of this file is compressed using zlib.
 xÚ­”KNÃ0†÷=…lSÑmw©‹HU‹ÄÒríibÉŽ-{RRV\ƒëqì$¥¥°ˆ;kòÿx±e΃ÐÌqb÷smD£€ÜYh§juÝDz’Mì—xº(òåƒsÆEZ¥©Éì”<GêSRäeé d+°Æa2_ä«»ÙGã ö’§âËxt‰õ®‹§Ô�beâ(hš+Lì×l"9å”�vBð‘ß65�û�•²Ãh©ëLÑÐAà!¨«Ël·ÃÔþÏ�VÆcB™šIòûF¥P-:Æ‘¶Z�fÊp·î4TëéÖæ²1m’ÉЬWiGcU£YMQjðÈ´��aš10Ú£;þÜ„­TöHicoq¶9‰ô�¶›ýehzÕâGÙ>Ž�û]ªÏYíÉ6ݯg´Íø¾½0äÕ˜]-¡î"Ä£˜+¶
E²9D;YÄãä(†Gщâ7a7Ñ�ã%>ÞÞ=	ÚFC�,¦¿š„‡ó—tvŸ>ô~Eÿæö‰‡·åÑÇzñºÿ¾d%L>
%;¤ë

py-modindex.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Python Module Index &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>Python Module Index &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -59,7 +59,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -200,7 +200,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

search.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Search &mdash; parsedmarc 3.7.1 documentation</title>
+  <title>Search &mdash; parsedmarc 3.7.2 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                3.7.1
+                3.7.2
               </div>
             
           
@@ -188,7 +188,7 @@
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'./',
-            VERSION:'3.7.1',
+            VERSION:'3.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',