Update documentation

ApeWorX · May 25, 2024 · 60c9a75 · 60c9a75
1 parent 07cc206
commit 60c9a75
Show file tree

Hide file tree

Showing 84 changed files with 5,979 additions and 13 deletions.
diff --git a/stable/.buildinfo b/stable/.buildinfo
@@ -1,4 +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: 2bf08dc798585fbbd01bfdca0fc09fdb
+config: 041b978ad7dfbedc4d772508d4dd16cb
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/stable/.doctrees/commands/run.doctree b/stable/.doctrees/commands/run.doctree
diff --git a/stable/.doctrees/environment.pickle b/stable/.doctrees/environment.pickle
diff --git a/stable/.doctrees/methoddocs/application.doctree b/stable/.doctrees/methoddocs/application.doctree
diff --git a/stable/.doctrees/methoddocs/exceptions.doctree b/stable/.doctrees/methoddocs/exceptions.doctree
diff --git a/stable/.doctrees/methoddocs/middlewares.doctree b/stable/.doctrees/methoddocs/middlewares.doctree
diff --git a/stable/.doctrees/methoddocs/runner.doctree b/stable/.doctrees/methoddocs/runner.doctree
diff --git a/stable/.doctrees/methoddocs/subscriptions.doctree b/stable/.doctrees/methoddocs/subscriptions.doctree
diff --git a/stable/.doctrees/methoddocs/utils.doctree b/stable/.doctrees/methoddocs/utils.doctree
diff --git a/stable/.doctrees/userguides/development.doctree b/stable/.doctrees/userguides/development.doctree
diff --git a/stable/_sources/userguides/development.md.txt b/stable/_sources/userguides/development.md.txt
@@ -156,18 +156,16 @@ For this to work, you must configure a [TaskIQ broker](https://taskiq-python.git
 
 ```bash
 export SILVERBACK_BROKER_CLASS="taskiq_redis:ListQueueBroker"
-export SILVERBACK_BROKER_URI="redis://127.0.0.1:6379"
+export SILVERBACK_BROKER_KWARGS='{"queue_name": "taskiq", "url": "redis://127.0.0.1:6379"}'
 
-silverback run "example:app" \
-    --network :mainnet:alchemy \
-    --runner "silverback.runner:WebsocketRunner"
+silverback run "example:app" --network :mainnet:alchemy
 ```
 
 And then the worker process with 2 worker subprocesses:
 
 ```bash
 export SILVERBACK_BROKER_CLASS="taskiq_redis:ListQueueBroker"
-export SILVERBACK_BROKER_URI="redis://127.0.0.1:6379"
+export SILVERBACK_BROKER_KWARGS='{"url": "redis://127.0.0.1:6379"}'
 
 silverback worker -w 2 "example:app"
 ```

diff --git a/stable/commands/run.html b/stable/commands/run.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>
@@ -157,7 +158,7 @@ <h2>run<a class="headerlink" href="#run" title="Permalink to this heading"></
 
 <dl class="std option">
 <dt class="sig sig-object std" id="cmdoption-run-runner">
-<span class="sig-name descname"><span class="pre">--runner</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;runner&gt;</span></span><a class="headerlink" href="#cmdoption-run-runner" title="Permalink to this definition"></a></dt>
+<span class="sig-name descname"><span class="pre">--runner</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;runner_class&gt;</span></span><a class="headerlink" href="#cmdoption-run-runner" title="Permalink to this definition"></a></dt>
 <dd><p>An import str in format ‘&lt;module&gt;:&lt;CustomRunner&gt;’</p>
 </dd></dl>
 

diff --git a/stable/genindex.html b/stable/genindex.html
@@ -47,6 +47,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/stable/index.html b/stable/index.html
@@ -49,6 +49,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/stable/methoddocs/application.html b/stable/methoddocs/application.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/stable/methoddocs/exceptions.html b/stable/methoddocs/exceptions.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/stable/methoddocs/middlewares.html b/stable/methoddocs/middlewares.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/stable/methoddocs/runner.html b/stable/methoddocs/runner.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/stable/methoddocs/subscriptions.html b/stable/methoddocs/subscriptions.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/stable/methoddocs/utils.html b/stable/methoddocs/utils.html
@@ -49,6 +49,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/stable/py-modindex.html b/stable/py-modindex.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/stable/search.html b/stable/search.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/stable/searchindex.js b/stable/searchindex.js
diff --git a/stable/userguides/development.html b/stable/userguides/development.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>
@@ -269,16 +270,14 @@ <h3>Distributed Execution<a class="headerlink" href="#distributed-execution" tit
 <p>The primary components are the client and workers.  The client handles Silverback events (blocks and contract event logs) and creates jobs for the workers to process in an asynchronous manner.</p>
 <p>For this to work, you must configure a <a class="reference external" href="https://taskiq-python.github.io/guide/architecture-overview.html#broker">TaskIQ broker</a> capable of distributed processing.  For instance, with <a class="reference external" href="https://github.com/taskiq-python/taskiq-redis"><code class="docutils literal notranslate"><span class="pre">taskiq_redis</span></code></a> you could do something like this for the client:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_CLASS</span><span class="o">=</span><span class="s2">&quot;taskiq_redis:ListQueueBroker&quot;</span>
-<span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_URI</span><span class="o">=</span><span class="s2">&quot;redis://127.0.0.1:6379&quot;</span>
+<span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_KWARGS</span><span class="o">=</span><span class="s1">&#39;{&quot;queue_name&quot;: &quot;taskiq&quot;, &quot;url&quot;: &quot;redis://127.0.0.1:6379&quot;}&#39;</span>
 
-silverback<span class="w"> </span>run<span class="w"> </span><span class="s2">&quot;example:app&quot;</span><span class="w"> </span><span class="se">\</span>
-<span class="w">    </span>--network<span class="w"> </span>:mainnet:alchemy<span class="w"> </span><span class="se">\</span>
-<span class="w">    </span>--runner<span class="w"> </span><span class="s2">&quot;silverback.runner:WebsocketRunner&quot;</span>
+silverback<span class="w"> </span>run<span class="w"> </span><span class="s2">&quot;example:app&quot;</span><span class="w"> </span>--network<span class="w"> </span>:mainnet:alchemy
 </pre></div>
 </div>
 <p>And then the worker process with 2 worker subprocesses:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_CLASS</span><span class="o">=</span><span class="s2">&quot;taskiq_redis:ListQueueBroker&quot;</span>
-<span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_URI</span><span class="o">=</span><span class="s2">&quot;redis://127.0.0.1:6379&quot;</span>
+<span class="nb">export</span><span class="w"> </span><span class="nv">SILVERBACK_BROKER_KWARGS</span><span class="o">=</span><span class="s1">&#39;{&quot;url&quot;: &quot;redis://127.0.0.1:6379&quot;}&#39;</span>
 
 silverback<span class="w"> </span>worker<span class="w"> </span>-w<span class="w"> </span><span class="m">2</span><span class="w"> </span><span class="s2">&quot;example:app&quot;</span>
 </pre></div>

diff --git a/stable/userguides/quickstart.html b/stable/userguides/quickstart.html
@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.5.1">v0.5.1</option>
                 <option value="v0.5.0">v0.5.0</option>
                 <option value="v0.4.2">v0.4.2</option>
                 <option value="v0.4.1">v0.4.1</option>

diff --git a/v0.5.2/.buildinfo b/v0.5.2/.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: 041b978ad7dfbedc4d772508d4dd16cb
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/v0.5.2/.doctrees/commands/run.doctree b/v0.5.2/.doctrees/commands/run.doctree
diff --git a/v0.5.2/.doctrees/environment.pickle b/v0.5.2/.doctrees/environment.pickle
diff --git a/v0.5.2/.doctrees/index.doctree b/v0.5.2/.doctrees/index.doctree
diff --git a/v0.5.2/.doctrees/methoddocs/application.doctree b/v0.5.2/.doctrees/methoddocs/application.doctree
diff --git a/v0.5.2/.doctrees/methoddocs/exceptions.doctree b/v0.5.2/.doctrees/methoddocs/exceptions.doctree
diff --git a/v0.5.2/.doctrees/methoddocs/middlewares.doctree b/v0.5.2/.doctrees/methoddocs/middlewares.doctree
diff --git a/v0.5.2/.doctrees/methoddocs/runner.doctree b/v0.5.2/.doctrees/methoddocs/runner.doctree
diff --git a/v0.5.2/.doctrees/methoddocs/subscriptions.doctree b/v0.5.2/.doctrees/methoddocs/subscriptions.doctree
diff --git a/v0.5.2/.doctrees/methoddocs/utils.doctree b/v0.5.2/.doctrees/methoddocs/utils.doctree
diff --git a/v0.5.2/.doctrees/userguides/development.doctree b/v0.5.2/.doctrees/userguides/development.doctree
diff --git a/v0.5.2/.doctrees/userguides/quickstart.doctree b/v0.5.2/.doctrees/userguides/quickstart.doctree
diff --git a/v0.5.2/_sources/commands/run.rst.txt b/v0.5.2/_sources/commands/run.rst.txt
@@ -0,0 +1,6 @@
+run
+***
+
+.. click:: silverback._cli:run
+  :prog: run
+  :nested: none
diff --git a/v0.5.2/_sources/index.md.txt b/v0.5.2/_sources/index.md.txt
@@ -0,0 +1,31 @@
+# Silverback Docs
+
+```{eval-rst}
+.. toctree::
+   :caption: User Guides
+   :maxdepth: 1
+
+   userguides/quickstart
+   userguides/development
+```
+
+```{eval-rst}
+.. toctree::
+   :caption: CLI Reference
+   :maxdepth: 1
+
+   commands/run.rst
+```
+
+```{eval-rst}
+.. toctree::
+   :caption: Python Reference
+   :maxdepth: 1
+
+   methoddocs/application.md
+   methoddocs/runner.md
+   methoddocs/middlewares.md
+   methoddocs/subscriptions.md
+   methoddocs/exceptions.md
+   methoddocs/utils.md
+```
diff --git a/v0.5.2/_sources/methoddocs/application.md.txt b/v0.5.2/_sources/methoddocs/application.md.txt
@@ -0,0 +1,10 @@
+# silverback.application
+
+The `silverback.application` module contains the high-level implementation of the the user's
+Silverback application, meant to be used to expose method handlers and other functionality.
+
+```{eval-rst}
+.. automodule:: silverback.application
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.5.2/_sources/methoddocs/exceptions.md.txt b/v0.5.2/_sources/methoddocs/exceptions.md.txt
@@ -0,0 +1,7 @@
+# silverback.exceptions
+
+```{eval-rst}
+.. automodule:: silverback.exceptions
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.5.2/_sources/methoddocs/middlewares.md.txt b/v0.5.2/_sources/methoddocs/middlewares.md.txt
@@ -0,0 +1,10 @@
+# silverback.middlewares
+
+The `silverback.middlewares` module contains middleware intended to improve the usability of
+silverback as a whole, and add integrations for the silverback platform as well.
+
+```{eval-rst}
+.. automodule:: silverback.middlewares
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.5.2/_sources/methoddocs/runner.md.txt b/v0.5.2/_sources/methoddocs/runner.md.txt
@@ -0,0 +1,10 @@
+# silverback.runner
+
+The `silverback.runner` module contains implementations for running Silverback apps in a variety
+of different scenarios and trigger methods.
+
+```{eval-rst}
+.. automodule:: silverback.runner
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.5.2/_sources/methoddocs/subscriptions.md.txt b/v0.5.2/_sources/methoddocs/subscriptions.md.txt
@@ -0,0 +1,10 @@
+# silverback.subscriptions
+
+The `silverback.subscriptions` module contains an implementation of a Websocket subscription queue,
+used for connected to an RPC node via websockets that implements the `eth_subscribe` RPC method.
+
+```{eval-rst}
+.. automodule:: silverback.subscriptions
+    :members:
+    :show-inheritance:
+```
diff --git a/v0.5.2/_sources/methoddocs/utils.md.txt b/v0.5.2/_sources/methoddocs/utils.md.txt
@@ -0,0 +1,7 @@
+# silverback.utils
+
+```{eval-rst}
+.. automodule:: silverback.utils
+    :members:
+    :show-inheritance:
+```