Moved preambule to __init__.py

milcent · Feb 1, 2020 · fec8548 · fec8548
1 parent cc7f8e2
commit fec8548
Show file tree

Hide file tree

Showing 22 changed files with 144 additions and 118 deletions.
diff --git a/benford/__init__.py b/benford/__init__.py
@@ -1,3 +1,27 @@
+"""
+Benford_py for Python is a module for application of Benford's Law
+to a sequence of numbers.
+
+Dependent on pandas, numpy and matplotlib
+
+All logarithms ar in base 10: "log10"
+
+Author:  Marcel Milcent
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
 from .benford import *
 
 __version__ = '0.2.1'

diff --git a/benford/benford.py b/benford/benford.py
@@ -1,27 +1,3 @@
-"""
-Benford_py for Python is a module for application of Benford's Law
-to a sequence of numbers.
-
-Dependent on pandas, numpy and matplotlib
-
-All logarithms ar in base 10: "log10"
-
-Author:  Marcel Milcent
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""
-
 from pandas import Series, DataFrame
 from numpy import array, arange, log10, ones, abs, cos, sin, pi, sqrt, mean 
 import warnings

diff --git a/docs/build/doctrees/api.doctree b/docs/build/doctrees/api.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/html/_modules/benford/benford.html b/docs/build/html/_modules/benford/benford.html
@@ -78,8 +78,11 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../modules.html">benford</a></li>
+</ul>
+
 
 
         </div>
@@ -141,31 +144,7 @@
            <div itemprop="articleBody">
 
   <h1>Source code for benford.benford</h1><div class="highlight"><pre>
-<span></span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">Benford_py for Python is a module for application of Benford&#39;s Law</span>
-<span class="sd">to a sequence of numbers.</span>
-
-<span class="sd">Dependent on pandas, numpy and matplotlib</span>
-
-<span class="sd">All logarithms ar in base 10: &quot;log10&quot;</span>
-
-<span class="sd">Author:  Marcel Milcent</span>
-
-<span class="sd">This program is free software: you can redistribute it and/or modify</span>
-<span class="sd">it under the terms of the GNU General Public License as published by</span>
-<span class="sd">the Free Software Foundation, either version 3 of the License, or</span>
-<span class="sd">(at your option) any later version.</span>
-
-<span class="sd">This program is distributed in the hope that it will be useful,</span>
-<span class="sd">but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
-<span class="sd">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
-<span class="sd">GNU General Public License for more details.</span>
-
-<span class="sd">You should have received a copy of the GNU General Public License</span>
-<span class="sd">along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
-<span class="sd">&quot;&quot;&quot;</span>
-
-<span class="kn">from</span> <span class="nn">pandas</span> <span class="kn">import</span> <span class="n">Series</span><span class="p">,</span> <span class="n">DataFrame</span>
+<span></span><span class="kn">from</span> <span class="nn">pandas</span> <span class="kn">import</span> <span class="n">Series</span><span class="p">,</span> <span class="n">DataFrame</span>
 <span class="kn">from</span> <span class="nn">numpy</span> <span class="kn">import</span> <span class="n">array</span><span class="p">,</span> <span class="n">arange</span><span class="p">,</span> <span class="n">log10</span><span class="p">,</span> <span class="n">ones</span><span class="p">,</span> <span class="nb">abs</span><span class="p">,</span> <span class="n">cos</span><span class="p">,</span> <span class="n">sin</span><span class="p">,</span> <span class="n">pi</span><span class="p">,</span> <span class="n">sqrt</span><span class="p">,</span> <span class="n">mean</span> 
 <span class="kn">import</span> <span class="nn">warnings</span>
 <span class="kn">from</span> <span class="nn">.constants</span> <span class="kn">import</span> <span class="n">confs</span><span class="p">,</span> <span class="n">digs_dict</span><span class="p">,</span> <span class="n">sec_order_dict</span><span class="p">,</span> <span class="n">rev_digs</span><span class="p">,</span> <span class="n">names</span><span class="p">,</span> \

diff --git a/docs/build/html/_modules/benford/expected.html b/docs/build/html/_modules/benford/expected.html
@@ -78,8 +78,11 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../modules.html">benford</a></li>
+</ul>
+
 
 
         </div>

diff --git a/docs/build/html/_modules/benford/stats.html b/docs/build/html/_modules/benford/stats.html
@@ -78,8 +78,11 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../modules.html">benford</a></li>
+</ul>
+
 
 
         </div>

diff --git a/docs/build/html/_modules/benford/utils.html b/docs/build/html/_modules/benford/utils.html
@@ -78,8 +78,11 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../modules.html">benford</a></li>
+</ul>
+
 
 
         </div>

diff --git a/docs/build/html/_modules/benford/viz.html b/docs/build/html/_modules/benford/viz.html
@@ -78,8 +78,11 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../modules.html">benford</a></li>
+</ul>
+
 
 
         </div>

diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -78,8 +78,11 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../modules.html">benford</a></li>
+</ul>
+
 
 
         </div>

diff --git a/docs/build/html/_sources/api.rst.txt b/docs/build/html/_sources/api.rst.txt
@@ -1,9 +1,6 @@
 benford package
 ===============
 
-Submodules
-----------
-
 benford.benford module
 ----------------------
 

diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -2,9 +2,10 @@ Welcome to benford_py's documentation!
 ======================================
 
 .. toctree::
-   :maxdepth: 2
-   :caption: modules:
+   :maxdepth: 3
+   :caption: Contents:
 
+   modules
 
 
 Indices and tables

diff --git a/docs/build/html/api.html b/docs/build/html/api.html
@@ -34,7 +34,8 @@
   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" /> 
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="benford" href="modules.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -78,18 +79,20 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"><ul>
-<li><a class="reference internal" href="#">benford package</a><ul>
-<li><a class="reference internal" href="#submodules">Submodules</a></li>
-<li><a class="reference internal" href="#module-benford.benford">benford.benford module</a></li>
-<li><a class="reference internal" href="#module-benford.expected">benford.expected module</a></li>
-<li><a class="reference internal" href="#module-benford.stats">benford.stats module</a></li>
-<li><a class="reference internal" href="#module-benford.viz">benford.viz module</a></li>
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal" href="modules.html">benford</a><ul class="current">
+<li class="toctree-l2 current"><a class="current reference internal" href="#">benford package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#module-benford.benford">benford.benford module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-benford.expected">benford.expected module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-benford.stats">benford.stats module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-benford.viz">benford.viz module</a></li>
 </ul>
 </li>
 </ul>
-</div>
+</li>
+</ul>
+
 
 
         </div>
@@ -133,6 +136,8 @@
 
       <li><a href="index.html">Docs</a> &raquo;</li>
 
+          <li><a href="modules.html">benford</a> &raquo;</li>
+
       <li>benford package</li>
 
 
@@ -154,26 +159,8 @@
 
   <div class="section" id="benford-package">
 <h1>benford package<a class="headerlink" href="#benford-package" title="Permalink to this headline">¶</a></h1>
-<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-benford.benford">
 <span id="benford-benford-module"></span><h2>benford.benford module<a class="headerlink" href="#module-benford.benford" title="Permalink to this headline">¶</a></h2>
-<p>Benford_py for Python is a module for application of Benford’s Law
-to a sequence of numbers.</p>
-<p>Dependent on pandas, numpy and matplotlib</p>
-<p>All logarithms ar in base 10: “log10”</p>
-<p>Author:  Marcel Milcent</p>
-<p>This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.</p>
-<p>This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.</p>
-<p>You should have received a copy of the GNU General Public License
-along with this program.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
 <dl class="class">
 <dt id="benford.benford.Base">
 <em class="property">class </em><code class="sig-prename descclassname">benford.benford.</code><code class="sig-name descname">Base</code><span class="sig-paren">(</span><em class="sig-param">data</em>, <em class="sig-param">decimals</em>, <em class="sig-param">sign='all'</em>, <em class="sig-param">sec_order=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/benford/benford.html#Base"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#benford.benford.Base" title="Permalink to this definition">¶</a></dt>
@@ -1715,6 +1702,13 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
           </div>
           <footer>
 
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+
+        <a href="modules.html" class="btn btn-neutral float-left" title="benford" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+    </div>
+
 
   <hr/>
 

diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
@@ -79,8 +79,11 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"></div>
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="modules.html">benford</a></li>
+</ul>
+
 
 
         </div>

diff --git a/docs/build/html/index.html b/docs/build/html/index.html
@@ -34,7 +34,8 @@
   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" /> 
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="benford" href="modules.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -78,12 +79,11 @@
 
 
 
-              <!-- Local TOC -->
-              <div class="local-toc"><ul>
-<li><a class="reference internal" href="#">Welcome to benford_py’s documentation!</a></li>
-<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
+              <p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="modules.html">benford</a></li>
 </ul>
-</div>
+
 
 
         </div>
@@ -149,6 +149,19 @@
   <div class="section" id="welcome-to-benford-py-s-documentation">
 <h1>Welcome to benford_py’s documentation!<a class="headerlink" href="#welcome-to-benford-py-s-documentation" title="Permalink to this headline">¶</a></h1>
 <div class="toctree-wrapper compound">
+<p class="caption"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="modules.html">benford</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api.html">benford package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-benford.benford">benford.benford module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-benford.expected">benford.expected module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-benford.stats">benford.stats module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="api.html#module-benford.viz">benford.viz module</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
 </div>
 </div>
 <div class="section" id="indices-and-tables">
@@ -166,6 +179,13 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
           </div>
           <footer>
 
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+        <a href="modules.html" class="btn btn-neutral float-right" title="benford" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+    </div>
+
 
   <hr/>