-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
88 changed files
with
169,864 additions
and
408,968 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 056dc52fa141be1de2939b33f4f953cf | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
|
||
<!DOCTYPE html> | ||
|
||
<html> | ||
<head> | ||
<meta charset="utf-8" /> | ||
<title>Overview: module code — ms3 unknown documentation</title> | ||
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" /> | ||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> | ||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> | ||
<script src="../_static/jquery.js"></script> | ||
<script src="../_static/underscore.js"></script> | ||
<script src="../_static/doctools.js"></script> | ||
<script src="../_static/language_data.js"></script> | ||
<link rel="index" title="Index" href="../genindex.html" /> | ||
<link rel="search" title="Search" href="../search.html" /> | ||
|
||
<link rel="stylesheet" href="../_static/custom.css" type="text/css" /> | ||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> | ||
|
||
</head><body> | ||
|
||
|
||
<div class="document"> | ||
<div class="documentwrapper"> | ||
<div class="bodywrapper"> | ||
|
||
|
||
<div class="body" role="main"> | ||
|
||
<h1>All modules for which code is available</h1> | ||
<ul><li><a href="ms3/score.html">ms3.score</a></li> | ||
<li><a href="ms3/skeleton.html">ms3.skeleton</a></li> | ||
</ul> | ||
|
||
</div> | ||
|
||
</div> | ||
</div> | ||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | ||
<div class="sphinxsidebarwrapper"> | ||
<h1 class="logo"><a href="../index.html">ms3</a></h1> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3> | ||
<ul> | ||
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../authors.html">Authors</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../api/modules.html">Module Reference</a></li> | ||
</ul> | ||
|
||
<div class="relations"> | ||
<h3>Related Topics</h3> | ||
<ul> | ||
<li><a href="../index.html">Documentation overview</a><ul> | ||
</ul></li> | ||
</ul> | ||
</div> | ||
<div id="searchbox" style="display: none" role="search"> | ||
<h3 id="searchlabel">Quick search</h3> | ||
<div class="searchformwrapper"> | ||
<form class="search" action="../search.html" method="get"> | ||
<input type="text" name="q" aria-labelledby="searchlabel" /> | ||
<input type="submit" value="Go" /> | ||
</form> | ||
</div> | ||
</div> | ||
<script>$('#searchbox').show(0);</script> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div> | ||
</div> | ||
<div class="clearer"></div> | ||
</div> | ||
<div class="footer"> | ||
©2020, laserjeyes. | ||
|
||
| | ||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.3</a> | ||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> | ||
|
||
</div> | ||
|
||
|
||
|
||
|
||
</body> | ||
</html> |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,221 @@ | ||
|
||
<!DOCTYPE html> | ||
|
||
<html> | ||
<head> | ||
<meta charset="utf-8" /> | ||
<title>ms3.skeleton — ms3 unknown documentation</title> | ||
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" /> | ||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> | ||
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> | ||
<script src="../../_static/jquery.js"></script> | ||
<script src="../../_static/underscore.js"></script> | ||
<script src="../../_static/doctools.js"></script> | ||
<script src="../../_static/language_data.js"></script> | ||
<link rel="index" title="Index" href="../../genindex.html" /> | ||
<link rel="search" title="Search" href="../../search.html" /> | ||
|
||
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" /> | ||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> | ||
|
||
</head><body> | ||
|
||
|
||
<div class="document"> | ||
<div class="documentwrapper"> | ||
<div class="bodywrapper"> | ||
|
||
|
||
<div class="body" role="main"> | ||
|
||
<h1>Source code for ms3.skeleton</h1><div class="highlight"><pre> | ||
<span></span><span class="c1"># -*- coding: utf-8 -*-</span> | ||
<span class="sd">"""</span> | ||
<span class="sd">This is a skeleton file that can serve as a starting point for a Python</span> | ||
<span class="sd">console script. To run this script uncomment the following lines in the</span> | ||
<span class="sd">[options.entry_points] section in setup.cfg:</span> | ||
|
||
<span class="sd"> console_scripts =</span> | ||
<span class="sd"> fibonacci = ms3.skeleton:run</span> | ||
|
||
<span class="sd">Then run `python setup.py install` which will install the command `fibonacci`</span> | ||
<span class="sd">inside your current environment.</span> | ||
<span class="sd">Besides console scripts, the header (i.e. until _logger...) of this file can</span> | ||
<span class="sd">also be used as template for Python modules.</span> | ||
|
||
<span class="sd">Note: This skeleton file can be safely removed if not needed!</span> | ||
<span class="sd">"""</span> | ||
|
||
<span class="kn">import</span> <span class="nn">argparse</span> | ||
<span class="kn">import</span> <span class="nn">sys</span> | ||
<span class="kn">import</span> <span class="nn">logging</span> | ||
|
||
<span class="kn">from</span> <span class="nn">ms3</span> <span class="kn">import</span> <span class="n">__version__</span> | ||
|
||
<span class="n">__author__</span> <span class="o">=</span> <span class="s2">"laserjeyes"</span> | ||
<span class="n">__copyright__</span> <span class="o">=</span> <span class="s2">"laserjeyes"</span> | ||
<span class="n">__license__</span> <span class="o">=</span> <span class="s2">"gpl3"</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> | ||
|
||
|
||
<div class="viewcode-block" id="fib"><a class="viewcode-back" href="../../api/ms3.html#ms3.skeleton.fib">[docs]</a><span class="k">def</span> <span class="nf">fib</span><span class="p">(</span><span class="n">n</span><span class="p">):</span> | ||
<span class="sd">"""Fibonacci example function</span> | ||
|
||
<span class="sd"> Args:</span> | ||
<span class="sd"> n (int): integer</span> | ||
|
||
<span class="sd"> Returns:</span> | ||
<span class="sd"> int: n-th Fibonacci number</span> | ||
<span class="sd"> """</span> | ||
<span class="k">assert</span> <span class="n">n</span> <span class="o">></span> <span class="mi">0</span> | ||
<span class="n">a</span><span class="p">,</span> <span class="n">b</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span> | ||
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n</span><span class="o">-</span><span class="mi">1</span><span class="p">):</span> | ||
<span class="n">a</span><span class="p">,</span> <span class="n">b</span> <span class="o">=</span> <span class="n">b</span><span class="p">,</span> <span class="n">a</span><span class="o">+</span><span class="n">b</span> | ||
<span class="k">return</span> <span class="n">a</span></div> | ||
|
||
|
||
<div class="viewcode-block" id="parse_args"><a class="viewcode-back" href="../../api/ms3.html#ms3.skeleton.parse_args">[docs]</a><span class="k">def</span> <span class="nf">parse_args</span><span class="p">(</span><span class="n">args</span><span class="p">):</span> | ||
<span class="sd">"""Parse command line parameters</span> | ||
|
||
<span class="sd"> Args:</span> | ||
<span class="sd"> args ([str]): command line parameters as list of strings</span> | ||
|
||
<span class="sd"> Returns:</span> | ||
<span class="sd"> :obj:`argparse.Namespace`: command line parameters namespace</span> | ||
<span class="sd"> """</span> | ||
<span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">(</span> | ||
<span class="n">description</span><span class="o">=</span><span class="s2">"Just a Fibonacci demonstration"</span><span class="p">)</span> | ||
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span> | ||
<span class="s2">"--version"</span><span class="p">,</span> | ||
<span class="n">action</span><span class="o">=</span><span class="s2">"version"</span><span class="p">,</span> | ||
<span class="n">version</span><span class="o">=</span><span class="s2">"ms3 </span><span class="si">{ver}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">ver</span><span class="o">=</span><span class="n">__version__</span><span class="p">))</span> | ||
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span> | ||
<span class="n">dest</span><span class="o">=</span><span class="s2">"n"</span><span class="p">,</span> | ||
<span class="n">help</span><span class="o">=</span><span class="s2">"n-th Fibonacci number"</span><span class="p">,</span> | ||
<span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span> | ||
<span class="n">metavar</span><span class="o">=</span><span class="s2">"INT"</span><span class="p">)</span> | ||
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span> | ||
<span class="s2">"-v"</span><span class="p">,</span> | ||
<span class="s2">"--verbose"</span><span class="p">,</span> | ||
<span class="n">dest</span><span class="o">=</span><span class="s2">"loglevel"</span><span class="p">,</span> | ||
<span class="n">help</span><span class="o">=</span><span class="s2">"set loglevel to INFO"</span><span class="p">,</span> | ||
<span class="n">action</span><span class="o">=</span><span class="s2">"store_const"</span><span class="p">,</span> | ||
<span class="n">const</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">INFO</span><span class="p">)</span> | ||
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span> | ||
<span class="s2">"-vv"</span><span class="p">,</span> | ||
<span class="s2">"--very-verbose"</span><span class="p">,</span> | ||
<span class="n">dest</span><span class="o">=</span><span class="s2">"loglevel"</span><span class="p">,</span> | ||
<span class="n">help</span><span class="o">=</span><span class="s2">"set loglevel to DEBUG"</span><span class="p">,</span> | ||
<span class="n">action</span><span class="o">=</span><span class="s2">"store_const"</span><span class="p">,</span> | ||
<span class="n">const</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span> | ||
<span class="k">return</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">(</span><span class="n">args</span><span class="p">)</span></div> | ||
|
||
|
||
<div class="viewcode-block" id="setup_logging"><a class="viewcode-back" href="../../api/ms3.html#ms3.skeleton.setup_logging">[docs]</a><span class="k">def</span> <span class="nf">setup_logging</span><span class="p">(</span><span class="n">loglevel</span><span class="p">):</span> | ||
<span class="sd">"""Setup basic logging</span> | ||
|
||
<span class="sd"> Args:</span> | ||
<span class="sd"> loglevel (int): minimum loglevel for emitting messages</span> | ||
<span class="sd"> """</span> | ||
<span class="n">logformat</span> <span class="o">=</span> <span class="s2">"[</span><span class="si">%(asctime)s</span><span class="s2">] </span><span class="si">%(levelname)s</span><span class="s2">:</span><span class="si">%(name)s</span><span class="s2">:</span><span class="si">%(message)s</span><span class="s2">"</span> | ||
<span class="n">logging</span><span class="o">.</span><span class="n">basicConfig</span><span class="p">(</span><span class="n">level</span><span class="o">=</span><span class="n">loglevel</span><span class="p">,</span> <span class="n">stream</span><span class="o">=</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">,</span> | ||
<span class="nb">format</span><span class="o">=</span><span class="n">logformat</span><span class="p">,</span> <span class="n">datefmt</span><span class="o">=</span><span class="s2">"%Y-%m-</span><span class="si">%d</span><span class="s2"> %H:%M:%S"</span><span class="p">)</span></div> | ||
|
||
|
||
<div class="viewcode-block" id="main"><a class="viewcode-back" href="../../api/ms3.html#ms3.skeleton.main">[docs]</a><span class="k">def</span> <span class="nf">main</span><span class="p">(</span><span class="n">args</span><span class="p">):</span> | ||
<span class="sd">"""Main entry point allowing external calls</span> | ||
|
||
<span class="sd"> Args:</span> | ||
<span class="sd"> args ([str]): command line parameter list</span> | ||
<span class="sd"> """</span> | ||
<span class="n">args</span> <span class="o">=</span> <span class="n">parse_args</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> | ||
<span class="n">setup_logging</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">loglevel</span><span class="p">)</span> | ||
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Starting crazy calculations..."</span><span class="p">)</span> | ||
<span class="nb">print</span><span class="p">(</span><span class="s2">"The </span><span class="si">{}</span><span class="s2">-th Fibonacci number is </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">n</span><span class="p">,</span> <span class="n">fib</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">n</span><span class="p">)))</span> | ||
<span class="n">_logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Script ends here"</span><span class="p">)</span></div> | ||
|
||
|
||
<div class="viewcode-block" id="run"><a class="viewcode-back" href="../../api/ms3.html#ms3.skeleton.run">[docs]</a><span class="k">def</span> <span class="nf">run</span><span class="p">():</span> | ||
<span class="sd">"""Entry point for console_scripts</span> | ||
<span class="sd"> """</span> | ||
<span class="n">main</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span></div> | ||
|
||
<div class="viewcode-block" id="score"><a class="viewcode-back" href="../../api/ms3.html#ms3.skeleton.score">[docs]</a><span class="k">class</span> <span class="nc">score</span><span class="p">():</span> | ||
<span class="k">pass</span></div> | ||
|
||
|
||
<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"__main__"</span><span class="p">:</span> | ||
<span class="n">run</span><span class="p">()</span> | ||
</pre></div> | ||
|
||
</div> | ||
|
||
</div> | ||
</div> | ||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation"> | ||
<div class="sphinxsidebarwrapper"> | ||
<h1 class="logo"><a href="../../index.html">ms3</a></h1> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3> | ||
<ul> | ||
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../authors.html">Authors</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../api/modules.html">Module Reference</a></li> | ||
</ul> | ||
|
||
<div class="relations"> | ||
<h3>Related Topics</h3> | ||
<ul> | ||
<li><a href="../../index.html">Documentation overview</a><ul> | ||
<li><a href="../index.html">Module code</a><ul> | ||
</ul></li> | ||
</ul></li> | ||
</ul> | ||
</div> | ||
<div id="searchbox" style="display: none" role="search"> | ||
<h3 id="searchlabel">Quick search</h3> | ||
<div class="searchformwrapper"> | ||
<form class="search" action="../../search.html" method="get"> | ||
<input type="text" name="q" aria-labelledby="searchlabel" /> | ||
<input type="submit" value="Go" /> | ||
</form> | ||
</div> | ||
</div> | ||
<script>$('#searchbox').show(0);</script> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div> | ||
</div> | ||
<div class="clearer"></div> | ||
</div> | ||
<div class="footer"> | ||
©2020, laserjeyes. | ||
|
||
| | ||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.3</a> | ||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> | ||
|
||
</div> | ||
|
||
|
||
|
||
|
||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ms3 | ||
=== | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ms3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
ms3 package | ||
=========== | ||
|
||
Submodules | ||
---------- | ||
|
||
ms3.score module | ||
---------------- | ||
|
||
.. automodule:: ms3.score | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
ms3.skeleton module | ||
------------------- | ||
|
||
.. automodule:: ms3.skeleton | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ms3 | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
.. _authors: | ||
.. include:: ../AUTHORS.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
.. _changes: | ||
.. include:: ../CHANGELOG.rst |
Oops, something went wrong.