PyPI - mindroot - Versions diffs - 9.10.0__py3-none-any.whl → 9.12.0__py3-none-any.whl - Mend - Supply Chain Defender

mindroot 9.10.0py3-none-any.whl → 9.12.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of mindroot might be problematic. Click here for more details.

Files changed (418) hide show

mindroot/docs/_build/html/_modules/mindroot/coreplugins/credits/ledger.html ADDED Viewed

@@ -0,0 +1,283 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>mindroot.coreplugins.credits.ledger &mdash; MindRoot 9.10.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=b86133f3" />
+      <link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
+      <script src="../../../../_static/jquery.js?v=5d32c60e"></script>
+      <script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+      <script src="../../../../_static/documentation_options.js?v=3c16008f"></script>
+      <script src="../../../../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../../search.html" />
+</head>
+<body class="wy-body-for-nav">
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search"  style="background: #343131" >
+          <a href="../../../../index.html" class="icon icon-home">
+            MindRoot
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../../getting_started.html">Getting Started</a></li>
+</ul>
+        </div>
+      </div>
+    </nav>
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu"  style="background: #343131" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../../index.html">MindRoot</a>
+      </nav>
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">mindroot.coreplugins.credits.ledger</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+  <h1>Source code for mindroot.coreplugins.credits.ledger</h1><div class="highlight"><pre>
+<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">datetime</span><span class="w"> </span><span class="kn">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">date</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Tuple</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">CreditTransaction</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">.storage</span><span class="w"> </span><span class="kn">import</span> <span class="n">CreditStorage</span>
+<div class="viewcode-block" id="InsufficientCreditsError">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.ledger.InsufficientCreditsError">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">InsufficientCreditsError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
+    <span class="k">pass</span></div>
+<div class="viewcode-block" id="CreditLedger">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.ledger.CreditLedger">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">CreditLedger</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Manages credit transactions and balances.</span>
+<span class="sd">    Ensures consistency and provides high-level credit operations.&quot;&quot;&quot;</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">storage</span><span class="p">:</span> <span class="n">CreditStorage</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_storage</span> <span class="o">=</span> <span class="n">storage</span>
+<div class="viewcode-block" id="CreditLedger.record_allocation">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.ledger.CreditLedger.record_allocation">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">record_allocation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">amount</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+                              <span class="n">source</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">reference_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                              <span class="n">metadata</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Record a credit allocation (positive credit change)&quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="n">amount</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Allocation amount must be positive&quot;</span><span class="p">)</span>
+        <span class="n">current_balance</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_storage</span><span class="o">.</span><span class="n">get_latest_balance</span><span class="p">(</span><span class="n">username</span><span class="p">)</span>
+        <span class="n">new_balance</span> <span class="o">=</span> <span class="n">current_balance</span> <span class="o">+</span> <span class="n">amount</span>
+        <span class="n">transaction</span> <span class="o">=</span> <span class="n">CreditTransaction</span><span class="p">(</span>
+            <span class="n">timestamp</span><span class="o">=</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">(),</span>
+            <span class="n">username</span><span class="o">=</span><span class="n">username</span><span class="p">,</span>
+            <span class="n">amount</span><span class="o">=</span><span class="n">amount</span><span class="p">,</span>
+            <span class="n">balance</span><span class="o">=</span><span class="n">new_balance</span><span class="p">,</span>
+            <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;allocation&#39;</span><span class="p">,</span>
+            <span class="n">source</span><span class="o">=</span><span class="n">source</span><span class="p">,</span>
+            <span class="n">reference_id</span><span class="o">=</span><span class="n">reference_id</span><span class="p">,</span>
+            <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span> <span class="ow">or</span> <span class="p">{}</span>
+        <span class="p">)</span>
+        <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_storage</span><span class="o">.</span><span class="n">store_transaction</span><span class="p">(</span><span class="n">transaction</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">new_balance</span></div>
+<div class="viewcode-block" id="CreditLedger.record_usage">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.ledger.CreditLedger.record_usage">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">record_usage</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">amount</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+                          <span class="n">source</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">reference_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                          <span class="n">metadata</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+                          <span class="n">allow_negative</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Record a credit usage (negative credit change)&quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="n">amount</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Usage amount must be positive&quot;</span><span class="p">)</span>
+        <span class="n">current_balance</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_storage</span><span class="o">.</span><span class="n">get_latest_balance</span><span class="p">(</span><span class="n">username</span><span class="p">)</span>
+        <span class="n">new_balance</span> <span class="o">=</span> <span class="n">current_balance</span> <span class="o">-</span> <span class="n">amount</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">allow_negative</span> <span class="ow">and</span> <span class="n">new_balance</span> <span class="o">&lt;</span> <span class="mi">0</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="n">InsufficientCreditsError</span><span class="p">(</span>
+                <span class="sa">f</span><span class="s2">&quot;Insufficient credits: </span><span class="si">{</span><span class="n">current_balance</span><span class="si">}</span><span class="s2"> available, </span><span class="si">{</span><span class="n">amount</span><span class="si">}</span><span class="s2"> required&quot;</span>
+            <span class="p">)</span>
+        <span class="n">transaction</span> <span class="o">=</span> <span class="n">CreditTransaction</span><span class="p">(</span>
+            <span class="n">timestamp</span><span class="o">=</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">(),</span>
+            <span class="n">username</span><span class="o">=</span><span class="n">username</span><span class="p">,</span>
+            <span class="n">amount</span><span class="o">=-</span><span class="n">amount</span><span class="p">,</span>  <span class="c1"># Negative for usage</span>
+            <span class="n">balance</span><span class="o">=</span><span class="n">new_balance</span><span class="p">,</span>
+            <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;usage&#39;</span><span class="p">,</span>
+            <span class="n">source</span><span class="o">=</span><span class="n">source</span><span class="p">,</span>
+            <span class="n">reference_id</span><span class="o">=</span><span class="n">reference_id</span><span class="p">,</span>
+            <span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span> <span class="ow">or</span> <span class="p">{}</span>
+        <span class="p">)</span>
+        <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_storage</span><span class="o">.</span><span class="n">store_transaction</span><span class="p">(</span><span class="n">transaction</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">new_balance</span></div>
+<div class="viewcode-block" id="CreditLedger.record_refund">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.ledger.CreditLedger.record_refund">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">record_refund</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">amount</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
+                           <span class="n">source</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">reference_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                           <span class="n">original_transaction_id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                           <span class="n">metadata</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Dict</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Record a credit refund (reversal of usage)&quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="n">amount</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Refund amount must be positive&quot;</span><span class="p">)</span>
+        <span class="n">current_balance</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_storage</span><span class="o">.</span><span class="n">get_latest_balance</span><span class="p">(</span><span class="n">username</span><span class="p">)</span>
+        <span class="n">new_balance</span> <span class="o">=</span> <span class="n">current_balance</span> <span class="o">+</span> <span class="n">amount</span>
+        <span class="n">transaction</span> <span class="o">=</span> <span class="n">CreditTransaction</span><span class="p">(</span>
+            <span class="n">timestamp</span><span class="o">=</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">(),</span>
+            <span class="n">username</span><span class="o">=</span><span class="n">username</span><span class="p">,</span>
+            <span class="n">amount</span><span class="o">=</span><span class="n">amount</span><span class="p">,</span>
+            <span class="n">balance</span><span class="o">=</span><span class="n">new_balance</span><span class="p">,</span>
+            <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;refund&#39;</span><span class="p">,</span>
+            <span class="n">source</span><span class="o">=</span><span class="n">source</span><span class="p">,</span>
+            <span class="n">reference_id</span><span class="o">=</span><span class="n">reference_id</span><span class="p">,</span>
+            <span class="n">metadata</span><span class="o">=</span><span class="p">{</span>
+                <span class="o">**</span><span class="p">(</span><span class="n">metadata</span> <span class="ow">or</span> <span class="p">{}),</span>
+                <span class="s1">&#39;original_transaction_id&#39;</span><span class="p">:</span> <span class="n">original_transaction_id</span>
+            <span class="p">}</span>
+        <span class="p">)</span>
+        <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_storage</span><span class="o">.</span><span class="n">store_transaction</span><span class="p">(</span><span class="n">transaction</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">new_balance</span></div>
+<div class="viewcode-block" id="CreditLedger.get_balance">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.ledger.CreditLedger.get_balance">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">get_balance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Get current credit balance&quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_storage</span><span class="o">.</span><span class="n">get_latest_balance</span><span class="p">(</span><span class="n">username</span><span class="p">)</span></div>
+<div class="viewcode-block" id="CreditLedger.get_balance_at">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.ledger.CreditLedger.get_balance_at">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">get_balance_at</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">at_date</span><span class="p">:</span> <span class="n">date</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Get credit balance at a specific date&quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_storage</span><span class="o">.</span><span class="n">get_balance_at</span><span class="p">(</span><span class="n">username</span><span class="p">,</span> <span class="n">at_date</span><span class="p">)</span></div>
+<div class="viewcode-block" id="CreditLedger.get_transactions">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.ledger.CreditLedger.get_transactions">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">get_transactions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                             <span class="n">start_date</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">date</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+                             <span class="n">end_date</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">date</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="n">CreditTransaction</span><span class="p">]:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Get transaction history&quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_storage</span><span class="o">.</span><span class="n">get_transactions</span><span class="p">(</span><span class="n">username</span><span class="p">,</span> <span class="n">start_date</span><span class="p">,</span> <span class="n">end_date</span><span class="p">)</span></div>
+<div class="viewcode-block" id="CreditLedger.check_credits_available">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.ledger.CreditLedger.check_credits_available">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">check_credits_available</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                                    <span class="n">required_amount</span><span class="p">:</span> <span class="nb">float</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">float</span><span class="p">]:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Check if user has sufficient credits</span>
+<span class="sd">        </span>
+<span class="sd">        Returns:</span>
+<span class="sd">            Tuple of (bool: has_sufficient, float: current_balance)</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">current_balance</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_balance</span><span class="p">(</span><span class="n">username</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">current_balance</span> <span class="o">&gt;=</span> <span class="n">required_amount</span><span class="p">,</span> <span class="n">current_balance</span></div>
+<div class="viewcode-block" id="CreditLedger.get_usage_summary">
+<a class="viewcode-back" href="../../../../source/mindroot.coreplugins.credits.html#mindroot.coreplugins.credits.ledger.CreditLedger.get_usage_summary">[docs]</a>
+    <span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">get_usage_summary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
+                              <span class="n">start_date</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">date</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+                              <span class="n">end_date</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">date</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Get summary of credit usage&quot;&quot;&quot;</span>
+        <span class="n">transactions</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_transactions</span><span class="p">(</span><span class="n">username</span><span class="p">,</span> <span class="n">start_date</span><span class="p">,</span> <span class="n">end_date</span><span class="p">)</span>
+        <span class="n">summary</span> <span class="o">=</span> <span class="p">{</span>
+            <span class="s1">&#39;total_allocated&#39;</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
+            <span class="s1">&#39;total_used&#39;</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
+            <span class="s1">&#39;total_refunded&#39;</span><span class="p">:</span> <span class="mf">0.0</span><span class="p">,</span>
+            <span class="s1">&#39;usage_by_source&#39;</span><span class="p">:</span> <span class="p">{},</span>
+            <span class="s1">&#39;allocations_by_source&#39;</span><span class="p">:</span> <span class="p">{}</span>
+        <span class="p">}</span>
+        <span class="k">for</span> <span class="n">txn</span> <span class="ow">in</span> <span class="n">transactions</span><span class="p">:</span>
+            <span class="k">if</span> <span class="n">txn</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="s1">&#39;allocation&#39;</span><span class="p">:</span>
+                <span class="n">summary</span><span class="p">[</span><span class="s1">&#39;total_allocated&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="n">txn</span><span class="o">.</span><span class="n">amount</span>
+                <span class="k">if</span> <span class="n">txn</span><span class="o">.</span><span class="n">source</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">summary</span><span class="p">[</span><span class="s1">&#39;allocations_by_source&#39;</span><span class="p">]:</span>
+                    <span class="n">summary</span><span class="p">[</span><span class="s1">&#39;allocations_by_source&#39;</span><span class="p">][</span><span class="n">txn</span><span class="o">.</span><span class="n">source</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.0</span>
+                <span class="n">summary</span><span class="p">[</span><span class="s1">&#39;allocations_by_source&#39;</span><span class="p">][</span><span class="n">txn</span><span class="o">.</span><span class="n">source</span><span class="p">]</span> <span class="o">+=</span> <span class="n">txn</span><span class="o">.</span><span class="n">amount</span>
+            <span class="k">elif</span> <span class="n">txn</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="s1">&#39;usage&#39;</span><span class="p">:</span>
+                <span class="n">summary</span><span class="p">[</span><span class="s1">&#39;total_used&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="nb">abs</span><span class="p">(</span><span class="n">txn</span><span class="o">.</span><span class="n">amount</span><span class="p">)</span>
+                <span class="k">if</span> <span class="n">txn</span><span class="o">.</span><span class="n">source</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">summary</span><span class="p">[</span><span class="s1">&#39;usage_by_source&#39;</span><span class="p">]:</span>
+                    <span class="n">summary</span><span class="p">[</span><span class="s1">&#39;usage_by_source&#39;</span><span class="p">][</span><span class="n">txn</span><span class="o">.</span><span class="n">source</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.0</span>
+                <span class="n">summary</span><span class="p">[</span><span class="s1">&#39;usage_by_source&#39;</span><span class="p">][</span><span class="n">txn</span><span class="o">.</span><span class="n">source</span><span class="p">]</span> <span class="o">+=</span> <span class="nb">abs</span><span class="p">(</span><span class="n">txn</span><span class="o">.</span><span class="n">amount</span><span class="p">)</span>
+            <span class="k">elif</span> <span class="n">txn</span><span class="o">.</span><span class="n">type</span> <span class="o">==</span> <span class="s1">&#39;refund&#39;</span><span class="p">:</span>
+                <span class="n">summary</span><span class="p">[</span><span class="s1">&#39;total_refunded&#39;</span><span class="p">]</span> <span class="o">+=</span> <span class="n">txn</span><span class="o">.</span><span class="n">amount</span>
+        <span class="k">return</span> <span class="n">summary</span></div>
+</div>
+</pre></div>
+           </div>
+          </div>
+          <footer>
+  <hr/>
+  <div role="contentinfo">
+    <p>&#169; Copyright 2025, Jason Livesay.</p>
+  </div>
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+</body>
+</html>