Update from fluxninja/aperture

fluxninja · Dec 5, 2023 · d8d9c27 · d8d9c27
1 parent 293d0de
commit d8d9c27
Show file tree

Hide file tree

Showing 38 changed files with 10,976 additions and 211 deletions.
diff --git a/aperture_sdk/client.py b/aperture_sdk/client.py
@@ -1,3 +1,5 @@
+"""ApertureClient for starting Flows."""
+
 import datetime
 import functools
 import logging
@@ -58,6 +60,10 @@ class FlowParams:
 
 
 class ApertureClient:
+    """
+    ApertureClient can be used to start Flows.
+    """
+
     def __init__(
         self,
         channel: grpc.Channel,

diff --git a/aperture_sdk/flow.py b/aperture_sdk/flow.py
@@ -1,3 +1,5 @@
+"""Flow started using the ApertureClient."""
+
 import datetime
 import logging
 import time

diff --git a/docs/all-documents.html b/docs/all-documents.html
@@ -139,7 +139,7 @@ <h1>All Documents</h1>
             <div class="type">Package</div>
             <div class="kind">Package</div>
             <div class="privacy">PUBLIC</div>
-            <div class="summary"><span class="undocumented">Undocumented</span></div>
+            <div class="summary"><span class="undocumented">No package docstring; 2/5 modules, 0/1 package documented</span></div>
           </li><li id="aperture_sdk._gen">
 
             <div class="fullName">aperture<wbr></wbr>_sdk<wbr></wbr>._gen</div>
@@ -211,7 +211,7 @@ <h1>All Documents</h1>
             <div class="type">Module</div>
             <div class="kind">Module</div>
             <div class="privacy">PUBLIC</div>
-            <div class="summary"><span class="undocumented">Undocumented</span></div>
+            <div class="summary">ApertureClient for starting Flows.</div>
           </li><li id="aperture_sdk.const">
 
             <div class="fullName">aperture<wbr></wbr>_sdk<wbr></wbr>.const</div>
@@ -227,7 +227,7 @@ <h1>All Documents</h1>
             <div class="type">Module</div>
             <div class="kind">Module</div>
             <div class="privacy">PUBLIC</div>
-            <div class="summary"><span class="undocumented">Undocumented</span></div>
+            <div class="summary">Flow started using the ApertureClient.</div>
           </li><li id="aperture_sdk.utils">
 
             <div class="fullName">aperture<wbr></wbr>_sdk<wbr></wbr>.utils</div>
@@ -812,6 +812,22 @@ <h1>All Documents</h1>
             <div class="kind">Method</div>
             <div class="privacy">PUBLIC</div>
             <div class="summary"><span class="undocumented">Undocumented</span></div>
+          </li><li id="aperture_sdk.flow.Flow.http_response_code">
+
+            <div class="fullName">aperture<wbr></wbr>_sdk<wbr></wbr>.flow<wbr></wbr>.<wbr></wbr>Flow<wbr></wbr>.http<wbr></wbr>_response<wbr></wbr>_code</div>
+            <div class="url">aperture_sdk.flow.Flow.html#http_response_code</div>
+            <div class="type">Function</div>
+            <div class="kind">Method</div>
+            <div class="privacy">PUBLIC</div>
+            <div class="summary"><span class="undocumented">Undocumented</span></div>
+          </li><li id="aperture_sdk.flow.Flow.retry_after">
+
+            <div class="fullName">aperture<wbr></wbr>_sdk<wbr></wbr>.flow<wbr></wbr>.<wbr></wbr>Flow<wbr></wbr>.retry<wbr></wbr>_after</div>
+            <div class="url">aperture_sdk.flow.Flow.html#retry_after</div>
+            <div class="type">Function</div>
+            <div class="kind">Method</div>
+            <div class="privacy">PUBLIC</div>
+            <div class="summary"><span class="undocumented">Undocumented</span></div>
           </li><li id="aperture_sdk.flow.Flow.decision">
 
             <div class="fullName">aperture<wbr></wbr>_sdk<wbr></wbr>.flow<wbr></wbr>.<wbr></wbr>Flow<wbr></wbr>.decision</div>
@@ -1043,7 +1059,7 @@ <h1>All Documents</h1>
             <div class="type">Class</div>
             <div class="kind">Class</div>
             <div class="privacy">PUBLIC</div>
-            <div class="summary"><span class="undocumented">Undocumented</span></div>
+            <div class="summary">ApertureClient can be used to start Flows.</div>
           </li><li id="aperture_sdk.client.ApertureClient.__init__">
 
             <div class="fullName">aperture<wbr></wbr>_sdk<wbr></wbr>.client<wbr></wbr>.<wbr></wbr>Aperture<wbr></wbr>Client<wbr></wbr>.__init__</div>

diff --git a/docs/aperture_sdk._gen.aperture.flowcontrol.check.html b/docs/aperture_sdk._gen.aperture.flowcontrol.check.html
@@ -155,10 +155,69 @@ <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
 
 
 
+            <div class="itemName expandableItem">
+                <input class="tocChildrenToggle" type="checkbox" id="expandableItemId18"> 
+
+                </input>
 
+                <label class="lbl-toggle" for="expandableItemId18">
+
+
+                </label>
+
+                <code><a href="aperture_sdk._gen.aperture.flowcontrol.check.v1.html" class="internal-link" title="aperture_sdk._gen.aperture.flowcontrol.check.v1">v1</a></code>
+
+                <div class="expandableContent">
+                    <div>
 
-            <div class="itemName"><code><a href="aperture_sdk._gen.aperture.flowcontrol.check.v1.html" class="internal-link" title="aperture_sdk._gen.aperture.flowcontrol.check.v1">v1</a></code>
+
+        <div class="childrenKindTitle">Modules</div>
+        <ul>
+
+    <li class="">
+
+
+
+
+
+            <div class="itemName"><code><a href="aperture_sdk._gen.aperture.flowcontrol.check.v1.check_pb2.html" class="internal-link" title="aperture_sdk._gen.aperture.flowcontrol.check.v1.check_pb2">check<wbr></wbr>_pb2</a></code>
+            </div>
+
+
+    </li><li class="">
+
+
+
+
+
+            <div class="itemName"><code><a href="aperture_sdk._gen.aperture.flowcontrol.check.v1.check_pb2_grpc.html" class="internal-link" title="aperture_sdk._gen.aperture.flowcontrol.check.v1.check_pb2_grpc">check<wbr></wbr>_pb2<wbr></wbr>_grpc</a></code>
+            </div>
+
+
+    </li>
+</ul> 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+      </div>
+                </div>
             </div>
+
+
+
 
 
     </li>
@@ -197,10 +256,59 @@ <h1>Cannot search: JavaScript is not supported/enabled in your browser.</h1>
 
 
 
+            <div class="itemName expandableItem">
+                <input class="tocChildrenToggle" type="checkbox" id="expandableItemId19"> 
+
+                </input>
+
+                <label class="lbl-toggle notExpandable" for="">
+
+
+                </label>
+
+                <code><a href="aperture_sdk._gen.aperture.flowcontrol.check.html" class="internal-link" title="aperture_sdk._gen.aperture.flowcontrol.check">check</a></code>
+
+                <div class="expandableContent">
+                    <div>
+
+
+        <div class="childrenKindTitle">Modules</div>
+        <ul>
+
+    <li class="">
+
+
+
+
+
+            <div class="itemName"><code><a href="aperture_sdk._gen.aperture.flowcontrol.check.v1.html" class="internal-link" title="aperture_sdk._gen.aperture.flowcontrol.check.v1">v1</a></code>
+            </div>
+
+
+    </li>
+</ul> 
+
+
+
 
 
-            <div class="itemName"><code><a href="aperture_sdk._gen.aperture.flowcontrol.check.html" class="internal-link" title="aperture_sdk._gen.aperture.flowcontrol.check">check</a></code>
+
+
+
+
+
+
+
+
+
+
+
+      </div>
+                </div>
             </div>
+
+
+
 
 
     </li>
@@ -288,7 +396,7 @@ <h1 class="package"><code><code><a href="index.html" class="internal-link">apert
   <div class="container">
     <a href="index.html">API Documentation</a> for <a href="https://github.com/fluxninja/aperture/tree/main/sdks/aperture-py" class="projecthome">aperture-py</a>,
   generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
-    23.9.1 at 2023-11-30 16:05:21.
+    23.9.1 at 2023-12-05 04:20:29.
   </div>
 
   <!-- Search related scripts needs to be loaded at the end of HTML