Skip to content

Commit

Permalink
Deployed 1fb6212 with MkDocs version: 1.2.4
Browse files Browse the repository at this point in the history
  • Loading branch information
xuhcc committed Sep 1, 2024
1 parent 27e32b6 commit 287a72c
Show file tree
Hide file tree
Showing 14 changed files with 69 additions and 63 deletions.
10 changes: 5 additions & 5 deletions api_reference/beancount.core.html
Original file line number Diff line number Diff line change
Expand Up @@ -3225,7 +3225,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 0x7a32089c1e20&gt;)</code>
<code class="highlight language-python">beancount.core.amount.Amount.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x749446ea74d0&gt;)</code>


<a href="#beancount.core.amount.Amount.to_string" class="headerlink" title="Permanent link"></a></h4>
Expand Down Expand Up @@ -7622,7 +7622,7 @@ <h3 id="beancount.core.data.new_directive" class="doc doc-heading">
<th class="field-name">Returns:</th>
<td class="field-body">
<ul class="first simple">
<li><p><code>&lt;function NamedTuple at 0x7a3208e3b240&gt;</code> – A type object for the new directive type.</p></li>
<li><p><code>&lt;function NamedTuple at 0x749447011120&gt;</code> – A type object for the new directive type.</p></li>
</ul>
</td>
</tr>
Expand Down Expand Up @@ -14009,7 +14009,7 @@ <h4 id="beancount.core.inventory.Inventory.segregate_units" class="doc doc-headi


<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 0x7a32089c1e20&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 0x749446ea74d0&gt;, parens=True)</code>


<a href="#beancount.core.inventory.Inventory.to_string" class="headerlink" title="Permanent link"></a></h4>
Expand Down Expand Up @@ -15847,7 +15847,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 0x7a32089c1e20&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 0x749446ea74d0&gt;, detail=True)</code>


<a href="#beancount.core.position.Position.to_string" class="headerlink" title="Permanent link"></a></h4>
Expand Down Expand Up @@ -16254,7 +16254,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 0x7a32089c1e20&gt;, detail=True)</code>
<code class="highlight language-python">beancount.core.position.to_string(pos, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x749446ea74d0&gt;, detail=True)</code>


<a href="#beancount.core.position.to_string" class="headerlink" title="Permanent link"></a></h3>
Expand Down
8 changes: 4 additions & 4 deletions api_reference/beancount.parser.html
Original file line number Diff line number Diff line change
Expand Up @@ -3785,7 +3785,7 @@ <h3 id="beancount.parser.cmptest.TestError" class="doc doc-heading">


<h3 id="beancount.parser.cmptest.assertEqualEntries" class="doc doc-heading">
<code class="highlight language-python">beancount.parser.cmptest.assertEqualEntries(expected_entries, actual_entries, failfunc=&lt;function fail at 0x7a3207e94680&gt;, allow_incomplete=False)</code>
<code class="highlight language-python">beancount.parser.cmptest.assertEqualEntries(expected_entries, actual_entries, failfunc=&lt;function fail at 0x74944608c540&gt;, allow_incomplete=False)</code>


<a href="#beancount.parser.cmptest.assertEqualEntries" class="headerlink" title="Permanent link"></a></h3>
Expand Down Expand Up @@ -3886,7 +3886,7 @@ <h3 id="beancount.parser.cmptest.assertEqualEntries" class="doc doc-heading">


<h3 id="beancount.parser.cmptest.assertExcludesEntries" class="doc doc-heading">
<code class="highlight language-python">beancount.parser.cmptest.assertExcludesEntries(subset_entries, entries, failfunc=&lt;function fail at 0x7a3207e94680&gt;, allow_incomplete=False)</code>
<code class="highlight language-python">beancount.parser.cmptest.assertExcludesEntries(subset_entries, entries, failfunc=&lt;function fail at 0x74944608c540&gt;, allow_incomplete=False)</code>


<a href="#beancount.parser.cmptest.assertExcludesEntries" class="headerlink" title="Permanent link"></a></h3>
Expand Down Expand Up @@ -3978,7 +3978,7 @@ <h3 id="beancount.parser.cmptest.assertExcludesEntries" class="doc doc-heading">


<h3 id="beancount.parser.cmptest.assertIncludesEntries" class="doc doc-heading">
<code class="highlight language-python">beancount.parser.cmptest.assertIncludesEntries(subset_entries, entries, failfunc=&lt;function fail at 0x7a3207e94680&gt;, allow_incomplete=False)</code>
<code class="highlight language-python">beancount.parser.cmptest.assertIncludesEntries(subset_entries, entries, failfunc=&lt;function fail at 0x74944608c540&gt;, allow_incomplete=False)</code>


<a href="#beancount.parser.cmptest.assertIncludesEntries" class="headerlink" title="Permanent link"></a></h3>
Expand Down Expand Up @@ -9662,7 +9662,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 0x7a320938d4f0&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 0x7494475894f0&gt;, converter=None, deprecated=False, alias=None)</code>


<a href="#beancount.parser.options.Opt" class="headerlink" title="Permanent link"></a></h3>
Expand Down
2 changes: 1 addition & 1 deletion api_reference/beancount.tools.html
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,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 0x7a3206d45540&gt;, prefix='')</code>
<code class="highlight language-python">beancount.tools.treeify.dump_tree(node, file=&lt;_io.StringIO object at 0x749444f21780&gt;, prefix='')</code>


<a href="#beancount.tools.treeify.dump_tree" class="headerlink" title="Permanent link"></a></h3>
Expand Down
2 changes: 1 addition & 1 deletion api_reference/beancount.utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -4422,7 +4422,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 0x7a3208a21bc0&gt;, cmp=&lt;function &lt;lambda&gt; at 0x7a3208a21c60&gt;)</code>
<code class="highlight language-python">beancount.utils.misc_utils.is_sorted(iterable, key=&lt;function &lt;lambda&gt; at 0x749446c30cc0&gt;, cmp=&lt;function &lt;lambda&gt; at 0x749446c30d60&gt;)</code>


<a href="#beancount.utils.misc_utils.is_sorted" class="headerlink" title="Permanent link"></a></h3>
Expand Down
2 changes: 1 addition & 1 deletion beancount_scripting_plugins.html
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ <h2 id="introduction">Introduction<a id="introduction"></a><a class="headerlink"
<p>This document provides examples and guidelines on how to write scripts that use the contents of your ledger. It also provides information on how to write your own “plugins,” which are just Python functions that you can configure to transform your transactions or synthesize ones programmatically. These are the main two methods for extending Beancount’s features and for writing your own custom reports. You simply use Python to do this.</p>
<h2 id="load-pipeline">Load Pipeline<a id="load-pipeline"></a><a class="headerlink" href="#load-pipeline" title="Permanent link"></a></h2>
<p>You need to know a little bit about how Beancount processes its input files. Internally, the single point of entry to load an input file is the <code>beancount.loader.load_file()</code> function, which accepts an input file and carries out a list of transformation steps, as in this diagram:</p>
<p><img src="beancount_scripting_plugins/media/4117596158f0642dae7becf17be7a89f169bf4a0.png" style="width:8.66667in;height:3.23611in" /></p>
<p><img src="beancount_scripting_plugins/media/6bbbdc0339d6207eab9d578bc1fc954db96ed97d.png" style="width:8.66667in;height:3.23611in" /></p>
<p>The stages of loading are as follows:</p>
<ol>
<li>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion beancount_v3.html
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ <h3 id="restructuring-the-code">Restructuring the Code<a id="restructuring-the-c
</li>
</ul>
<p>Note that because the core outputs the stream of directives as proto objects, any language supported by protobufs should be able to read those. This extends the reach of Beancount. Here's a simplified diagram showing how this might look:</p>
<p><img src="beancount_v3/media/c8e76e1f74eeaba6ecb79f612719f105efac6b88.png" style="width:3.47222in;height:3.38889in" /></p>
<p><img src="beancount_v3/media/b738066dfe69a152d18f2d828ca1663cc0b29a93.png" style="width:3.47222in;height:3.38889in" /></p>
<p>Here is a detailed breakdown of the various parts of the codebase today and what I think will happen to them:</p>
<ul>
<li>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
6 changes: 6 additions & 0 deletions external_contributions.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@
<li class="toctree-l4"><a class="reference internal" href="#using-tree-sitter">Using Tree-sitter</a>
</li>
<li class="toctree-l4"><a class="reference internal" href="#in-rust">In Rust</a>
</li>
<li class="toctree-l4"><a class="reference internal" href="#emacs-lisp">Emacs Lisp</a>
</li>
</ul>
</li>
Expand Down Expand Up @@ -270,6 +272,8 @@ <h2 id="books-and-articles">Books and Articles<a id="books-and-articles"></a><a
<p><a href="https://reds-rants.netlify.app/personal-finance/scaled-estimates-of-mutual-fund-navs/"><u>Scaled Estimates of Mutual Fund NAVs</u></a> (RedStreet) : Problem: Mutual fund NAVs (at least in the US) are updated exactly once per day, at the end of the day. When needing to make financial decisions when the trading window is still open (eg: when tax loss harvesting), and the end-of-day NAV is not yet available, it is sometimes useful to make a trivial estimate of that NAV, especially on days when there are huge changes in the market.</p>
<p><a href="https://noisysignal.com/trade_hist_shortcut/"><u>A Shortcut to Scrape Trade History from Fidelity</u></a> (David Avraamides) I wrote up a description of how I use a Shortcut to scrape trade history from Fidelity’s website, run it through a Python script to convert to Beancount’s ledger format, and then save it in the clipboard so I can paste it into a ledger file.</p>
<p><a href="https://lazy-beancount.xyz/"><u>Lazy Beancount</u></a> (Vasily M) / <a href="https://github.com/Evernight/lazy-beancount"><u>Evernight/lazy-beancount</u></a> : Opinionated guide on how to start (and continue) tracking personal finances using the open-source Beancount accounting system. It comes together with some code. The primary goal of this guide is to provide you a way to start managing your own finances using plain-text accounting gradually and incrementally. Also with various useful tools already included and set up.</p>
<p><a href="https://academy.beanhub.io/"><u>The Zen of Balance — https://academy.beanhub.io/</u></a> (Fang-Pen Lin) : An explanation of double-entry accounting using visualizations and diagrams.</p>
<p><a href="https://www.isabekov.pro/multiperiod-hledger-style-reports-in-beancount-pivoting-a-table/"><u>Multiperiod hledger-Style Reports in beancount: Pivoting a Table | Altynbek Isabekov</u></a> : An article showing how to produce pivot table summaries of account balances, e.g. by year, with <a href="https://github.com/isabekov/beancount-multiperiod-reports"><u>associated code (github)</u></a>.</p>
<h2 id="plugins">Plugins<a id="plugins"></a><a class="headerlink" href="#plugins" title="Permanent link"></a></h2>
<p><a href="https://www.google.com/url?q=https%3A%2F%2Fgist.github.com%2Fkljohann%2Faebac3f0146680fd9aa5&amp;sa=D&amp;sntz=1&amp;usg=AFQjCNGn2AkL35onTeXgOQzLzkjVpvLcpg"><u>split_transactions</u></a>: Johann Klähn <a href="https://groups.google.com/d/msg/beancount/z9sPboW4U3c/1qIIzro4zFoJ"><u>wrote a plugin</u></a> that can split a single transaction into many against a limbo account, as would be done for depreciation.</p>
<p><a href="https://github.com/redstreet/beancount_reds_plugins"><u>zerosum</u></a>: Red S <a href="https://groups.google.com/d/msg/beancount/MU6KozsmqGQ/sehD3dqZslEJ"><u>wrote a plugin</u></a> to match up transactions that when taken together should sum up to zero and move them to a separate account.</p>
Expand Down Expand Up @@ -322,6 +326,8 @@ <h3 id="using-tree-sitter">Using Tree-sitter<a id="using-tree-sitter"></a><a cla
<h3 id="in-rust">In Rust<a id="in-rust"></a><a class="headerlink" href="#in-rust" title="Permanent link"></a></h3>
<p><a href="https://github.com/jcornaz/beancount-parser"><u>jcornaz/beancount-parser</u></a> (Jonathan Cornaz): A beancount file parser library for Rust. Uses nom.</p>
<p><a href="https://docs.rs/beancount-parser-lima/latest/beancount_parser_lima/"><u>beancount_parser_lima</u></a> (Simon Guest): A zero-copy parser for Beancount in Rust. It is intended to be a complete implementation of the Beancount file format, except for those parts which are deprecated and other features as documented here (in a list which may not be comprehensive). Uses <a href="https://docs.rs/logos/latest/logos/"><u>Logos</u></a>, <a href="https://docs.rs/chumsky/latest/chumsky/"><u>Chumsky</u></a>, and <a href="https://docs.rs/ariadne/latest/ariadne/"><u>Ariadne</u></a>.</p>
<h3 id="emacs-lisp">Emacs Lisp<a id="emacs-lisp"></a><a class="headerlink" href="#emacs-lisp" title="Permanent link"></a></h3>
<p><a href="https://sr.ht/~trs-80/beancount-txn-elisp/"><u>trs-80/beancount-txn-elisp/</u></a> : beancount-txn-elisp: A library to read/parse and write/insert individual Beancount transactions, implemented in Emacs Lisp.</p>
<h2 id="importers">Importers<a id="importers"></a><a class="headerlink" href="#importers" title="Permanent link"></a></h2>
<p><a href="https://github.com/redstreet/beancount_reds_importers"><u>reds importers</u></a>: Simple importers and tools for <a href="https://github.com/redstreet/beancount_reds_importers/tree/main/beancount_reds_importers"><u>several</u></a> US based institutions, and various file types. Emphasizes ease of writing your own importers by providing well maintained common libraries for banks, credit cards, and investment houses, and for various file types, which minimizes the institution specific code you need to write. This is a reference implementation of the principles expressed in <strong><a href="https://reds-rants.netlify.app/personal-finance/the-five-minute-ledger-update/"><u>The Five Minute Ledger Update</u></a>.</strong> Contributions welcome. By RedStreet</p>
<p><a href="https://github.com/madhat2r/plaid2text"><u>plaid2text</u></a>: An importer from <a href="http://www.plaid.com/"><u>Plaid</u></a> which stores the transactions to a Mongo DB and is able to render it to Beancount syntax. By Micah Duke.</p>
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 : 2024-08-01 06:22:21.127956+00:00
Build Date UTC : 2024-09-01 08:58:49.662135+00:00
-->
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit 287a72c

Please sign in to comment.