Deployed 8ead3ef with MkDocs version: 1.2.4

api_reference/beancount.core.html

@@ -3405,7 +3405,7 @@ <h4 id="beancount.core.amount.Amount.from_string" class="doc doc-heading">
 
 
 <h4 id="beancount.core.amount.Amount.to_string" class="doc doc-heading">
-<code class="highlight language-python">beancount.core.amount.Amount.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x781d1bf3d010&gt;)</code>
+<code class="highlight language-python">beancount.core.amount.Amount.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7affecc71010&gt;)</code>
 
 
 <a href="#beancount.core.amount.Amount.to_string" class="headerlink" title="Permanent link"></a></h4>
@@ -17819,7 +17819,7 @@ <h4 id="beancount.core.inventory.Inventory.split" class="doc doc-heading">
 
 
 <h4 id="beancount.core.inventory.Inventory.to_string" class="doc doc-heading">
-<code class="highlight language-python">beancount.core.inventory.Inventory.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x781d1bf3d010&gt;, parens=True)</code>
+<code class="highlight language-python">beancount.core.inventory.Inventory.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7affecc71010&gt;, parens=True)</code>
 
 
 <a href="#beancount.core.inventory.Inventory.to_string" class="headerlink" title="Permanent link"></a></h4>
@@ -19945,7 +19945,7 @@ <h4 id="beancount.core.position.Position.sortkey" class="doc doc-heading">
 
 
 <h4 id="beancount.core.position.Position.to_string" class="doc doc-heading">
-<code class="highlight language-python">beancount.core.position.Position.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x781d1bf3d010&gt;, detail=True)</code>
+<code class="highlight language-python">beancount.core.position.Position.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7affecc71010&gt;, detail=True)</code>
 
 
 <a href="#beancount.core.position.Position.to_string" class="headerlink" title="Permanent link"></a></h4>
@@ -20352,7 +20352,7 @@ <h3 id="beancount.core.position.get_position" class="doc doc-heading">
 
 
 <h3 id="beancount.core.position.to_string" class="doc doc-heading">
-<code class="highlight language-python">beancount.core.position.to_string(pos, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x781d1bf3d010&gt;, detail=True)</code>
+<code class="highlight language-python">beancount.core.position.to_string(pos, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x7affecc71010&gt;, detail=True)</code>
 
 
 <a href="#beancount.core.position.to_string" class="headerlink" title="Permanent link"></a></h3>

api_reference/beancount.parser.html

@@ -10058,7 +10058,7 @@ <h4 id="beancount.parser.options.OptGroup.__repr__" class="doc doc-heading">
 
 
 <h3 id="beancount.parser.options.Opt" class="doc doc-heading">
-<code class="highlight language-python">beancount.parser.options.Opt(name, default_value, example_value=&lt;object object at 0x781d1c7909d0&gt;, converter=None, deprecated=False, alias=None)</code>
+<code class="highlight language-python">beancount.parser.options.Opt(name, default_value, example_value=&lt;object object at 0x7affed1809d0&gt;, converter=None, deprecated=False, alias=None)</code>
 
 
 <a href="#beancount.parser.options.Opt" class="headerlink" title="Permanent link"></a></h3>

api_reference/beancount.tools.html

@@ -466,7 +466,7 @@ <h3 id="beancount.tools.treeify.create_tree" class="doc doc-heading">
 
 
 <h3 id="beancount.tools.treeify.dump_tree" class="doc doc-heading">
-<code class="highlight language-python">beancount.tools.treeify.dump_tree(node, file=&lt;_io.StringIO object at 0x781d1c0a8880&gt;, prefix='')</code>
+<code class="highlight language-python">beancount.tools.treeify.dump_tree(node, file=&lt;_io.StringIO object at 0x7affecda4880&gt;, prefix='')</code>
 
 
 <a href="#beancount.tools.treeify.dump_tree" class="headerlink" title="Permanent link"></a></h3>

api_reference/beancount.utils.html

@@ -3579,7 +3579,7 @@ <h3 id="beancount.utils.misc_utils.import_curses" class="doc doc-heading">
 
 
 <h3 id="beancount.utils.misc_utils.is_sorted" class="doc doc-heading">
-<code class="highlight language-python">beancount.utils.misc_utils.is_sorted(iterable, key=&lt;function &lt;lambda&gt; at 0x781d1bf15d00&gt;, cmp=&lt;function &lt;lambda&gt; at 0x781d1bf15da0&gt;)</code>
+<code class="highlight language-python">beancount.utils.misc_utils.is_sorted(iterable, key=&lt;function &lt;lambda&gt; at 0x7affecc4dda0&gt;, cmp=&lt;function &lt;lambda&gt; at 0x7affecc4de40&gt;)</code>
 
 
 <a href="#beancount.utils.misc_utils.is_sorted" class="headerlink" title="Permanent link"></a></h3>

beancount_query_language.html

@@ -322,7 +322,7 @@ <h2 id="introduction">Introduction<a id="introduction"></a><a class="headerlink"
 <p>This document describes our specialized SQL-like query client. It assumes you have at least a passing knowledge of <a href="http://en.wikipedia.org/wiki/SQL"><u>SQL</u></a> syntax. If not, you may want to first read <a href="http://www.amazon.com/Practical-SQL-Handbook-Using-Variants/dp/0201703092/"><u>something</u></a> <a href="http://www.w3schools.com/sql/"><u>about</u></a> it.</p>
 <h2 id="motivation">Motivation<a id="motivation"></a><a class="headerlink" href="#motivation" title="Permanent link"></a></h2>
 <p>So one might ask: Why create another SQL client? Why not output the data to an SQLite database and allow the user to use that SQL client?</p>
-<p>Well, we have done that (see the <a href="https://github.com/beancount/beancount/tree/v2/beancount/scripts/sql.py"><u>bean-sql</u></a> script which converts your Beancount ledger into an SQLite database) and the results are not great. Writing queries is painful and carrying out operations on lots that are held at cost is difficult. By taking advantage of a few aspects of our in-memory data structures, we can do better. So Beancount comes with its own SQL-like query client called “<a href="https://github.com/beancount/beancount/tree/master/beancount/scripts/query.py"><u>bean-query</u></a>”.</p>
+<p>Well, we have done that (see the <a href="https://github.com/beancount/beancount/tree/v2/beancount/scripts/sql.py"><u>bean-sql</u></a> script which converts your Beancount ledger into an SQLite database) and the results are not great. Writing queries is painful and carrying out operations on lots that are held at cost is difficult. By taking advantage of a few aspects of our in-memory data structures, we can do better. So Beancount comes with its own SQL-like query client called “<a href="https://github.com/beancount/beanquery"><u>bean-query</u></a>”.</p>
 <p>The clients implements the following “extras” that are essential to Beancount:</p>
 <ul>
 <li>
@@ -449,7 +449,7 @@ <h2 id="data-types">Data Types<a id="data-types"></a><a class="headerlink" href=
 <p>String (Python str)</p>
 </li>
 <li>
-<p>Date (a datetime.date instance). You can parse a date with the <code>#"..."</code> syntax; this uses Python’s dateutil module and is pretty liberal in the formats it accepts.</p>
+<p>Date (a datetime.date instance). Dates are entered in <code>YYYY-MM-DD</code> format: <code>SELECT * WHERE date &lt; 2024-05-20</code>..</p>
 </li>
 <li>
 <p>Integer (Python int)</p>
@@ -528,7 +528,7 @@ <h2 id="operators">Operators<a id="operators"></a><a class="headerlink" href="#o
 <li>~ (search regexp)</li>
 </ul>
 <p>At the moment, matching groups are ignored.</p>
-<p>You can use string, number and integer constants with those operators, and parentheses to explicitly state precedence. You can use the <code>#”...”</code> literal syntax to input dates (valid contents for the string are pretty liberal, it supports anything Python’s dateutil.parser supports).</p>
+<p>You can use string, number and integer constants with those operators, and parentheses to explicitly state precedence.</p>
 <p>Here is an example query that uses a few of these:</p>
 <pre><code>SELECT date, payee 
 WHERE account ~ 'Expenses:Food:Restaurant' 
@@ -749,7 +749,7 @@ <h3 id="flattening-inventories">Flattening Inventories<a id="flattening-inventor
 <h3 id="sub-selects">Sub-Selects<a id="sub-selects"></a><a class="headerlink" href="#sub-selects" title="Permanent link"></a></h3>
 <p>The ability to select from the result of another <code>SELECT</code> is not currently supported, but the internals of the query code are prepared to do so.</p>
 <h2 id="more-information">More Information<a id="more-information"></a><a class="headerlink" href="#more-information" title="Permanent link"></a></h2>
-<p>This document attempts to provide a good high-level summary of the features supported in our query language. However, should you find you need more information, you may take a look at the <a href="http://furius.ca/beancount/doc/proposal-query"><u>original proposal</u></a>, or consult the source code under the <a href="https://github.com/beancount/beancount/tree/v2/beancount/query/"><u>beancount.query</u></a> directory. In particular, the <a href="https://github.com/beancount/beancount/tree/master/beancount/parser"><u>parser</u></a> will provide insight into the specifics of the syntax, and the <a href="https://github.com/beancount/beancount/tree/v2/beancount/query/query_env.py"><u>environments</u></a> will shed some light on the supported data columns and functions. Feel free to rummage in the source code and ask questions on the mailing-list.</p>
+<p>This document attempts to provide a good high-level summary of the features supported in our query language. However, should you find you need more information, you may take a look at the <a href="http://furius.ca/beancount/doc/proposal-query"><u>original proposal</u></a>, or consult the source code in the <a href="https://github.com/beancount/beanquery"><u>beanquery</u></a> repository. In particular, the <a href="https://github.com/beancount/beanquery/blob/master/beanquery/parser_test.py"><u>parser tests</u></a> will provide insight into the specifics of the syntax, and the <a href="https://github.com/beancount/beanquery/blob/master/beanquery/query_env_test.py"><u>query env tests</u></a> will shed some light on the supported data columns and functions. Feel free to rummage in the source code and ask questions on the mailing-list.</p>
 <h2 id="appendix">Appendix<a id="appendix"></a><a class="headerlink" href="#appendix" title="Permanent link"></a></h2>
 <h3 id="future-features_1">Future Features<a id="future-features-1"></a><a class="headerlink" href="#future-features_1" title="Permanent link"></a></h3>
 <p><em>This section documents ideas for features to be implemented in a future version.</em></p>

how_we_share_expenses.html

@@ -273,7 +273,7 @@ <h3 id="my-shared-expenses">My Shared Expenses<a id="my-shared-expenses"></a><a
   Assets:US:Share:Carolyn       13.06 USD
     share: TRUE
 </code></pre>
-<p>This is done by a <a href="https://github.com/beancount/beancount/tree/master/experiments/sharing"><u>custom plugin</u></a> I built that splits the expenses according to some rules that we have between us (see also <a href="https://github.com/Akuukis/beancount_share"><u>this plugin by Akkukis</u></a>). In this example, 40% of 32.66 (13.06) gets rerouted to her account. Note that this is an asset account for me, because she owes this.</p>
+<p>This is done by a <a href="https://github.com/beancount/beanlabs/tree/master/beanlabs/sharing"><u>custom plugin</u></a> I built that splits the expenses according to some rules that we have between us (see also <a href="https://github.com/Akuukis/beancount_share"><u>this plugin by Akkukis</u></a>). In this example, 40% of 32.66 (13.06) gets rerouted to her account. Note that this is an asset account for me, because she owes this.</p>
 <h3 id="her-shared-expenses">Her Shared Expenses<a id="her-shared-expenses"></a><a class="headerlink" href="#her-shared-expenses" title="Permanent link"></a></h3>
 <p>We also have to keep track of the money she spends on her own for shared expenses. Since she’s not a Beancount user, I’ve set up a Google Sheets doc in which she can add rows to a particular sheet. This sheet has fields: Date, Description, Account, Amount. I try to keep it simple.</p>
 <p>Then, I built an <a href="http://github.com/beancount/beancount/tree/master/experiments/sharing/extract_sheets.py"><u>extract_sheets.py</u></a> script that can pull down this data automatically and it writes it to a dedicated file for this, overwriting the entire contents each time. The contents of this ledger (<code>carolyn.beancount</code>) look like this:</p>

index.html

@@ -333,5 +333,5 @@ <h2 id="about-this-documentation">About this Documentation<a id="about-this-docu
 
 <!--
 MkDocs version : 1.2.4
-Build Date UTC : 2025-01-30 10:07:37.043622+00:00
+Build Date UTC : 2025-02-28 09:33:37.446663+00:00
 -->

installing_beancount.html

@@ -268,7 +268,7 @@ <h4 id="installing-beancount-using-pip">Installing Beancount using pip<a id="ins
 <pre><code>sudo -H python3 -m pip install beancount
 </code></pre>
 <p>This should automatically download and install all the dependencies.</p>
-<p>Note, however, that this will install the latest version that was pushed to the <a href="https://pypi.python.org/pypi/beancount/"><u>PyPI repository</u></a> and not the very latest version available from source. Releases to PyPI are made sporadically but frequently enough not to be too far behind. Consult the <a href="https://github.com/beancount/beancount/tree/v2/CHANGES"><u>CHANGES file</u></a> if you’d like to find out what is not included since the release date.</p>
+<p>Note, however, that this will install the latest version that was pushed to the <a href="https://pypi.python.org/pypi/beancount/"><u>PyPI repository</u></a> and not the very latest version available from source. Releases to PyPI are made sporadically but frequently enough not to be too far behind.</p>
 <p><strong>Warning: Proceed with caution this may break system libraries.</strong></p>
 <h4 id="installing-beancount-using-pip-from-the-repository">Installing Beancount using pip from the Repository<a id="installing-beancount-using-pip-from-the-repository"></a><a class="headerlink" href="#installing-beancount-using-pip-from-the-repository" title="Permanent link"></a></h4>
 <p>You can also use pip to install Beancount from its source code repository directly:</p>

running_beancount_and_generating_reports.html

@@ -61,6 +61,8 @@
                 </li>
                 <li class="toctree-l2 current"><a class="reference internal current" href="running_beancount_and_generating_reports.html">Running Beancount and Generating Reports</a>
     <ul class="current">
+    <li class="toctree-l3"><a class="reference internal" href="#important-this-document-applies-to-tools-from-the-v2-branch-which-have-been-deprecated-many-of-these-tools-have-been-deleted-for-v3-and-beyond">IMPORTANT: This document applies to tools from the v2 branch which have been deprecated. Many of these tools have been deleted for v3 and beyond.</a>
+    </li>
     <li class="toctree-l3"><a class="reference internal" href="#introduction">Introduction</a>
     </li>
     <li class="toctree-l3"><a class="reference internal" href="#tools">Tools</a>
@@ -294,6 +296,7 @@ <h1 id="running-beancount-generating-reports">Running Beancount &amp; Generating
 <p><a href="#statistics-stats"><u>Statistics (stats)</u></a></p>
 <p><a href="#update-activity-activity"><u>Update Activity (activity)</u></a></p>
 </blockquote>
+<h2 id="important-this-document-applies-to-tools-from-the-v2-branch-which-have-been-deprecated-many-of-these-tools-have-been-deleted-for-v3-and-beyond">IMPORTANT: This document applies to tools from the v2 branch which have been deprecated. Many of these tools have been deleted for v3 and beyond. <a id="important-this-document-applies-to-tools-from-the-v2-branch-which-have-been-deprecated.-many-of-these-tools-have-been-deleted-for-v3-and-beyond."></a><a class="headerlink" href="#important-this-document-applies-to-tools-from-the-v2-branch-which-have-been-deprecated-many-of-these-tools-have-been-deleted-for-v3-and-beyond" title="Permanent link"></a></h2>
 <h2 id="introduction">Introduction<a id="introduction"></a><a class="headerlink" href="#introduction" title="Permanent link"></a></h2>
 <p>This document describes the tools you use to process Beancount input files, and many of the reports available from it. The syntax of the language is described in the <a href="beancount_language_syntax.html"><u>Beancount Language Syntax</u></a> document. This manual only covers the technical details for using Beancount from the command-line.</p>
 <h2 id="tools">Tools<a id="tools"></a><a class="headerlink" href="#tools" title="Permanent link"></a></h2>