Skip to content

siddhantgoel/beancount-ing

Repository files navigation

Beancount ING Importer

image

image

image

image

beancount-ing provides an Importer for converting CSV exports of ING (Germany) account summaries to the Beancount format.

Installation

$ pip install beancount-ing

In case you prefer installing from the Github repository, please note that main is the development branch so stable is what you should be installing from.

Note that v1.x will only work with Beancount 3.x, while v0.x will only work with Beancount 2.x, due to incompatibilities between Beancount 3.x and 2.x.

Usage

If you're not familiar with how to import external data into Beancount, please read this guide first.

Beancount 3.x

Beancount 3.x has replaced the config.py file based workflow in favor of having a script based workflow, as per the changes documented here. As a result, the importer's initialization parameters have been shifted to pyproject.toml.

Add the following to your pyproject.toml in your project root.

[tool.beancount-ing.ec]
iban = "DE99 9999 9999 9999 9999 99"
account_name = "Assets:ING:EC"
user = "Erika Mustermann"
file_encoding = "ISO-8859-1"  # optional

Run beancount-ing-ec to call the EC importer. The identify and extract subcommands would identify the file and extract transactions for you.

$ beancount-ing-ec extract transaction.csv >> you.beancount

Beancount 2.x

Adjust your config file to include the provided ECImporter. A sample configuration might look like the following:

from beancount_ing import ECImporter

CONFIG = [
    # ...

    ECImporter(
        IBAN_NUMBER,
        "Assets:ING:EC",
        "Erika Mustermann",
        file_encoding="ISO-8859-1",
    ),

    # ...
]

Once this is in place, you should be able to run bean-extract on the command line to extract the transactions and pipe all of them into your Beancount file.

$ bean-extract /path/to/config.py transaction.csv >> you.beancount

Contributing

Contributions are most welcome!

Please make sure you have Python 3.8+ and Poetry installed.

  1. Clone the repository: git clone https://github.com/siddhantgoel/beancount-ing
  2. Install the packages required for development: poetry install
  3. That's basically it. You should now be able to run the test suite: poetry run pytest tests/.