Deployed 94a6bc3 with MkDocs version: 1.2.4

api_reference/beancount.core.html

@@ -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 0x77a204a6f200&gt;)</code>
+<code class="highlight language-python">beancount.core.amount.Amount.to_string(self, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x72972d9a3380&gt;)</code>
 
 
 <a href="#beancount.core.amount.Amount.to_string" class="headerlink" title="Permanent link"></a></h4>
@@ -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 0x77a204bd51c0&gt;</code> – A type object for the new directive type.</p></li>
+          <li><p><code>&lt;function NamedTuple at 0x72972db0d1c0&gt;</code> – A type object for the new directive type.</p></li>
         </ul>
     </td>
     </tr>
@@ -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 0x77a204a6f200&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 0x72972d9a3380&gt;, parens=True)</code>
 
 
 <a href="#beancount.core.inventory.Inventory.to_string" class="headerlink" title="Permanent link"></a></h4>
@@ -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 0x77a204a6f200&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 0x72972d9a3380&gt;, detail=True)</code>
 
 
 <a href="#beancount.core.position.Position.to_string" class="headerlink" title="Permanent link"></a></h4>
@@ -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 0x77a204a6f200&gt;, detail=True)</code>
+<code class="highlight language-python">beancount.core.position.to_string(pos, dformat=&lt;beancount.core.display_context.DisplayFormatter object at 0x72972d9a3380&gt;, detail=True)</code>
 
 
 <a href="#beancount.core.position.to_string" class="headerlink" title="Permanent link"></a></h3>

api_reference/beancount.parser.html

@@ -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 0x77a203e78220&gt;, allow_incomplete=False)</code>
+<code class="highlight language-python">beancount.parser.cmptest.assertEqualEntries(expected_entries, actual_entries, failfunc=&lt;function fail at 0x72972cb64180&gt;, allow_incomplete=False)</code>
 
 
 <a href="#beancount.parser.cmptest.assertEqualEntries" class="headerlink" title="Permanent link"></a></h3>
@@ -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 0x77a203e78220&gt;, allow_incomplete=False)</code>
+<code class="highlight language-python">beancount.parser.cmptest.assertExcludesEntries(subset_entries, entries, failfunc=&lt;function fail at 0x72972cb64180&gt;, allow_incomplete=False)</code>
 
 
 <a href="#beancount.parser.cmptest.assertExcludesEntries" class="headerlink" title="Permanent link"></a></h3>
@@ -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 0x77a203e78220&gt;, allow_incomplete=False)</code>
+<code class="highlight language-python">beancount.parser.cmptest.assertIncludesEntries(subset_entries, entries, failfunc=&lt;function fail at 0x72972cb64180&gt;, allow_incomplete=False)</code>
 
 
 <a href="#beancount.parser.cmptest.assertIncludesEntries" class="headerlink" title="Permanent link"></a></h3>
@@ -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 0x77a2051893e0&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 0x72972dd793e0&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

@@ -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 0x77a202d1da80&gt;, prefix='')</code>
+<code class="highlight language-python">beancount.tools.treeify.dump_tree(node, file=&lt;_io.StringIO object at 0x72972ba25a80&gt;, prefix='')</code>
 
 
 <a href="#beancount.tools.treeify.dump_tree" class="headerlink" title="Permanent link"></a></h3>

api_reference/beancount.utils.html

@@ -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 0x77a20480cae0&gt;, cmp=&lt;function &lt;lambda&gt; at 0x77a20480cb80&gt;)</code>
+<code class="highlight language-python">beancount.utils.misc_utils.is_sorted(iterable, key=&lt;function &lt;lambda&gt; at 0x72972d750a40&gt;, cmp=&lt;function &lt;lambda&gt; at 0x72972d750ae0&gt;)</code>
 
 
 <a href="#beancount.utils.misc_utils.is_sorted" class="headerlink" title="Permanent link"></a></h3>

external_contributions.html

@@ -305,6 +305,7 @@ <h2 id="tools">Tools<a id="tools"></a><a class="headerlink" href="#tools" title=
 <p><a href="https://github.com/PhracturedBlue/fava-encrypt"><u>PhracturedBlue/fava-encrypt</u></a> : A docker-base solution for keeping Fava online while keeping beancount data encrypted at rest. See <a href="https://groups.google.com/d/msgid/beancount/ece6f424-a86b-4e6d-8ecc-4e05c8e74373n%40googlegroups.com?utm_medium=email&amp;utm_source=footer"><u>this thread</u></a> for context.</p>
 <p><a href="https://github.com/kubauk/beancount-import-gmail"><u>kubauk/beancount-import-gmail</u></a> : beancount-import-gmail uses the gmail API and OAuth to log into your mailbox and download order details which are then used to augment your transactions for easier classification.</p>
 <p><a href="https://github.com/sulemankm/budget_report"><u>sulemankm/budget_report</u></a> : A very simple command-line budget tracking tool for beancount ledger files.</p>
+<p><a href="https://github.com/fdavies93/minibudget"><u>fdavies93/minibudget</u></a> (Frank Davies): MiniBudget is a tool designed to enable personal and small business budgeting using a plaintext format. It's inspired by beancount and plainbudget.</p>
 <p><a href="https://github.com/dyumnin/dyu_accounting"><u>dyumnin/dyu_accounting</u></a> : Accounting setup to automate generation of various financial statements for Compliance with Indian Govt.</p>
 <p><a href="https://github.com/redstreet/fava_investor/tree/main/fava_investor/modules/minimizegains"><u>Gains Minimizer</u></a> (RedStreet): Automatically determine lots to sell to minimize capital gains taxes. <a href="http://favainvestor.pythonanywhere.com/example-beancount-file/extension/Investor/?module=minimizegains"><u>Live example.</u></a></p>
 <p><a href="https://github.com/maread99/beanahead"><u>beanahead</u></a> (Marcus Read): Adds the ability to include future transactions (automatically generates regular transactions, provides for ad hoc expected transactions, expected transactions are reconciled against imported transactions; all functionality accessible via cli).</p>

importing_external_data.html

@@ -273,7 +273,7 @@ <h1 id="importing-external-data-in-beancount">Importing External Data in Beancou
 <p><a href="#automating-network-downloads"><u>Automating Network Downloads</u></a></p>
 <p><a href="#typical-downloads"><u>Typical Downloads</u></a></p>
 <p><a href="#extracting-data-from-pdf-files"><u>Extracting Data from PDF Files</u></a></p>
-<p><a href="#tools"><u>Tools</u></a></p>
+<p><a href="#_gbwtrndma055"><u>Tools</u></a></p>
 <p><a href="#invocation"><u>Invocation</u></a></p>
 <p><a href="#configuration"><u>Configuration</u></a></p>
 <p><a href="#configuring-from-an-input-file"><u>Configuring from an Input File</u></a></p>
@@ -346,8 +346,20 @@ <h4 id="extracting-data-from-pdf-files">Extracting Data from PDF Files<a id="ext
 <p>Nevertheless, I usually have good success with my importers grepping around PDF statements converted to ugly text in order to identify what institution they are for and extracting the date of issuance of the document.</p>
 <p>Finally, there are a number of different tools used to extract text from PDF documents, such as <a href="https://pypi.python.org/pypi/pdfminer2"><u>PDFMiner</u></a>, <a href="https://www.libreoffice.org"><u>LibreOffice</u></a>, the <a href="http://www.tutorialspoint.com/unix_commands/pdftotext.htm"><u>xpdf</u></a> library, the <a href="https://poppler.freedesktop.org/"><u>poppler</u></a> library<sup id="fnref:3"><a class="footnote-ref" href="#fn:3">3</a></sup> and more... but none of them works consistently on all input documents; you will likely end up installing many and relying on different ones for different input files. For this reason, I’m not requiring a dependency on PDF conversion tools from within Beancount. You should test what works on your specific documents and invoke those tools from your importer implementations.</p>
 <h3 id="automatic-download-with-open-banking-aggregator">Automatic download with open banking aggregator<a id="automatic-download-with-open-banking-aggregator"></a><a class="headerlink" href="#automatic-download-with-open-banking-aggregator" title="Permanent link"></a></h3>
-<p>The open-source accounting software Firefly III already integrates with some free open banking APIs. For more information, you can visit <a href="https://docs.firefly-iii.org/how-to/data-importer/import/gocardless/"><u>Firefly III Documentation</u></a>. The Beancount ecosystem is still lagging in this domain.</p>
-<p>An example of an open banking aggregator that could be interesting is GoCardless. GoCardless supports many PSD2-compliant banks in the EU and the UK, and it is <a href="https://nordigen.medium.com/were-launching-a-free-psd2-data-api-for-europe-941f6298c0dc"><u>free to use</u></a>.</p>
+<p>The open-source accounting software Firefly III already integrates with some free open banking APIs. For more information, you can visit <a href="https://docs.firefly-iii.org/how-to/data-importer/import/gocardless/"><u>Firefly III Documentation</u></a>. An example of an open banking aggregator that could be interesting is GoCardless. GoCardless supports many PSD2-compliant banks in the EU and the UK, and it is <a href="https://nordigen.medium.com/were-launching-a-free-psd2-data-api-for-europe-941f6298c0dc"><u>free to use</u></a>.</p>
+<p>In the Beancout ecosystem, the <a href="https://tariochbctools.readthedocs.io/en/latest/importers.html#nordigen"><u>tarioch/beancounttools</u></a> project contains an importer for Nordigen (which is the former name of the GoCardless banking api). This tool works with bean-extract.</p>
+<ol>
+<li>
+<p><a href="https://developer.gocardless.com/bank-account-data/quick-start-guide#step-5-list-accounts"><u>Simply create and configure a Gocardless account</u></a></p>
+</li>
+<li>
+<p><a href="https://tariochbctools.readthedocs.io/en/latest/importers.html#nordigen"><u>configure tarioch/beancounttools Nordigen importer</u></a>: add nordigen importer in my-smart.import and put nordigen.yaml in Downloads/</p>
+</li>
+<li>
+<p>run : `bean-extract -e database.beancount my-smart.import Download/ &gt; new.beancount`.</p>
+</li>
+</ol>
+<p>This will automatically ingest the data for you.</p>
 <h2 id="tools">Tools<a id="tools"></a><a class="headerlink" href="#tools" title="Permanent link"></a></h2>
 <p>There are three Beancount tools provided to orchestrate the three stages of importing:</p>
 <ol>

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 : 2024-10-01 08:52:10.854185+00:00
+Build Date UTC : 2024-11-01 10:23:27.294766+00:00
 -->

installing_beancount.html

@@ -257,12 +257,21 @@ <h3 id="installing-python">Installing Python<a id="installing-python"></a><a cla
 <p>First, you should have a working Python install. Install the latest stable version &gt;=3.8 using the download from <a href="http://python.org"><u>python.org</u></a>. Make sure you have the development headers and libraries installed as well (e.g., the “Python.h” header file). For example, on a Debian/Ubuntu system you would install the <strong><code>python3-dev</code></strong> package.</p>
 <p>Beancount supports setuptools since Feb 2016, and you will need to install dependencies. You will want to have the “pip3” tool installed. It’s installed by default along with Python3 by now—test this out by invoking “python3 -m pip --help” command.</p>
 <h3 id="installing-beancount_1">Installing Beancount<a id="installing-beancount"></a><a class="headerlink" href="#installing-beancount_1" title="Permanent link"></a></h3>
+<h4 id="installing-beancount-using-pipx">Installing Beancount using pipx<a id="installing-beancount-using-pipx"></a><a class="headerlink" href="#installing-beancount-using-pipx" title="Permanent link"></a></h4>
+<p>If you haven’t already, first <a href="https://github.com/pypa/pipx"><u>install pipx</u></a>.</p>
+<p>Next, use pipx to install Beancount. This should automatically download and install all the dependencies in a virtual environment.</p>
+<pre><code>pipx install beancount
+</code></pre>
+<p>Confirm Beancount has been installed.</p>
+<pre><code>pipx list
+</code></pre>
 <h4 id="installing-beancount-using-pip">Installing Beancount using pip<a id="installing-beancount-using-pip"></a><a class="headerlink" href="#installing-beancount-using-pip" title="Permanent link"></a></h4>
-<p>This is the easiest way to install Beancount. You just install Beancount using</p>
+<p>Installing Beancount using pip is no longer recommended, however you may install Beancount using</p>
 <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><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>
 <pre><code>sudo -H python3 -m pip install git+https://github.com/beancount/beancount#egg=beancount