Review docs; new package

ethereum · Aug 27, 2020 · d24f35b · d24f35b
1 parent b76d486
commit d24f35b
Show file tree

Hide file tree

Showing 49 changed files with 16,981 additions and 2 deletions.
diff --git a/dist/beaconrunner-0.1.2-py3-none-any.whl b/dist/beaconrunner-0.1.2-py3-none-any.whl
diff --git a/dist/beaconrunner-0.1.2.tar.gz b/dist/beaconrunner-0.1.2.tar.gz
diff --git a/dist/beaconrunner-0.1.3-py3-none-any.whl b/dist/beaconrunner-0.1.3-py3-none-any.whl
diff --git a/dist/beaconrunner-0.1.3.tar.gz b/dist/beaconrunner-0.1.3.tar.gz
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,7 +9,7 @@ Welcome to beaconrunner's documentation!
 .. toctree::
    :caption: Contents:
 
-   brlib
+   simulator
    BRValidator
    validators
 

diff --git a/docs/source/simulator.rst b/docs/source/simulator.rst
@@ -0,0 +1,5 @@
+simulator
+=========
+
+.. automodule:: beaconrunner.simulator
+   :members:
diff --git a/docs/source/sph/.buildinfo b/docs/source/sph/.buildinfo
@@ -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: 8ef939fa1076f4197d3cde99c9c5847b
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/source/sph/.doctrees/BRValidator.doctree b/docs/source/sph/.doctrees/BRValidator.doctree
diff --git a/docs/source/sph/.doctrees/brlib.doctree b/docs/source/sph/.doctrees/brlib.doctree
diff --git a/docs/source/sph/.doctrees/environment.pickle b/docs/source/sph/.doctrees/environment.pickle
diff --git a/docs/source/sph/.doctrees/index.doctree b/docs/source/sph/.doctrees/index.doctree
diff --git a/docs/source/sph/.doctrees/simulator.doctree b/docs/source/sph/.doctrees/simulator.doctree
diff --git a/docs/source/sph/.doctrees/validatorlib.doctree b/docs/source/sph/.doctrees/validatorlib.doctree
diff --git a/docs/source/sph/.doctrees/validators.doctree b/docs/source/sph/.doctrees/validators.doctree
diff --git a/docs/source/sph/BRValidator.html b/docs/source/sph/BRValidator.html
diff --git a/docs/source/sph/_modules/beaconrunner/simulator.html b/docs/source/sph/_modules/beaconrunner/simulator.html
diff --git a/docs/source/sph/_modules/beaconrunner/validatorlib.html b/docs/source/sph/_modules/beaconrunner/validatorlib.html
diff --git a/docs/source/sph/_modules/index.html b/docs/source/sph/_modules/index.html
@@ -0,0 +1,81 @@
+
+<!DOCTYPE html>
+
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Overview: module code &#8212; beaconrunner 0.1.2 documentation</title>
+    <link rel="stylesheet" href="../_static/nature.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" /> 
+  </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">beaconrunner 0.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
+      </ul>
+    </div>  
+
+    <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="beaconrunner/simulator.html">beaconrunner.simulator</a></li>
+<li><a href="beaconrunner/validatorlib.html">beaconrunner.validatorlib</a></li>
+</ul>
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<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="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">beaconrunner 0.1.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2020, Barnabé Monnot.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.1.2.
+    </div>
+  </body>
+</html>
diff --git a/docs/source/sph/_sources/BRValidator.rst.txt b/docs/source/sph/_sources/BRValidator.rst.txt
@@ -0,0 +1,5 @@
+BRValidator
+===========
+
+.. autoclass:: beaconrunner.validatorlib.BRValidator
+   :members:
diff --git a/docs/source/brlib.rst → docs/source/sph/_sources/brlib.rst.txt b/docs/source/brlib.rst → docs/source/sph/_sources/brlib.rst.txt
diff --git a/docs/source/sph/_sources/index.rst.txt b/docs/source/sph/_sources/index.rst.txt
@@ -0,0 +1,21 @@
+.. beaconrunner documentation master file, created by
+   sphinx-quickstart on Thu Jul  9 14:44:18 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to beaconrunner's documentation!
+========================================
+
+.. toctree::
+   :caption: Contents:
+
+   simulator
+   BRValidator
+   validators
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/source/sph/_sources/simulator.rst.txt b/docs/source/sph/_sources/simulator.rst.txt
@@ -0,0 +1,5 @@
+simulator
+=========
+
+.. automodule:: beaconrunner.simulator
+   :members:
diff --git a/docs/source/sph/_sources/validatorlib.rst.txt b/docs/source/sph/_sources/validatorlib.rst.txt
@@ -0,0 +1,2 @@
+validatorlib
+============
diff --git a/docs/source/sph/_sources/validators.rst.txt b/docs/source/sph/_sources/validators.rst.txt
@@ -0,0 +1,11 @@
+validators
+==========
+
+Validator behaviours subclass :py:class:`beaconrunner.validatorlib.BRValidator` and use attributes exposed in `self.data` (of type :py:class:`beaconrunner.validatorlib.ValidatorData`) to make decisions.
+Subclasses of `BRValidator` must define at least two methods:
+
+- `attest(self, known_items) -> Optional[Attestation]`
+- `propose(self, known_items) -> Optional[Attestation]`
+
+.. automodule:: beaconrunner.validators
+   :members: