siddhantgoel / beancount-ing Goto Github PK

Beancount Importers for ING (Germany) CSV Exports

License: MIT License

Python 100.00%

beancount python3 finance plaintext-accounting accounting germany banking personal-finance ing beancount-importers

beancount-ing's Introduction

Beancount ING Importer

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.

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

beancount-ing's People

Contributors

Stargazers

Watchers

Forkers

ganneff larsnolden codedump szabootibor erpreciso jinior sifr0x bergschrat1 dotlambda

beancount-ing's Issues

Unexpected sorting info line

Hi,

my ING CSV exports contain a header line that says something about sort order.

...
Saldo;XX,XX;EUR

Sortierung;Datum absteigend   <= HERE

In der CSV-Datei finden Sie alle bereits gebuchten Umsätze. Die vorgemerkten Umsätze werden nicht aufgenommen, auch wenn sie in Ihrem Internetbanking angezeigt werden.
...

This line seems to be unexpected in your importer.
https://github.com/siddhantgoel/beancount-ing-diba/blob/5a23c2bcf23cf7d69232d10c3786a42d89ea5b59/beancount_ing_diba/ec.py#L171-L179
Could you please check this?

Thanks and regards
Fred

Add support for Beancount 3

Beancount 3.x has been released which replaces beancount.ingest with beangulp.

User name restricted to two words

There seems to be a bug with user names, that consist of more than two words (first name + last name). See error output below. There should not be any restriction in this regard in order to make the package usable for everyone.

ERROR:root:Importer beancount_ing_diba.ec.ECImporter.extract() raised an unexpected error: too many values to unpack (expected 9)
Traceback (most recent call last):
  File "/Users/USERNAME/.virtualenvs/ENV/lib/python3.8/site-packages/beancount/ingest/extract.py", line 182, in extract
    new_entries = extract_from_file(
  File "/Users/USERNAME/.virtualenvs/ENV/lib/python3.8/site-packages/beancount/ingest/extract.py", line 67, in extract_from_file
    new_entries = importer.extract(file, **kwargs)
  File "/Users/USERNAME/.virtualenvs/ENV/lib/python3.8/site-packages/beancount_ing_diba/ec.py", line 210, in extract
    (
ValueError: too many values to unpack (expected 9)

When the name is reduced to two words (which does not match the name associated with the bank account in my case), the script runs through and gives the following output:
;; -*- mode: beancount -*-

Any chance, you can fix this soon?

Thanks for the great work!

How to use it exactly

Sorry for bothering you with the maybe simple question but I've just started to use beancount and its documentation about importers does not help me much. In the usage section of your importer project, you just posted a small python script which contains an import and an example configuration array. But I don't know where to put this file and it does not tell me how it is executed.

Could you clarify this eventually?

Thank you in advance.

Category not represented

Hi,

For me the importer only worked after I added the "Category" field. I think it's only active if you activated the "Analyse" as a user. Would be nice to have the option to activate/deactivate it.

Moreover, it's possible to download CSVs that don't have a Balance (Saldo), but this importer expects it to be there. Would be nice to mention this in the docs.

Initial Update

The bot created this issue to inform you that pyup.io has been set up on this repo.
Once you have closed it, the bot will open pull requests for updates as soon as they are available.

Add Github topics to the repository

Hi, can you add the following topic to this repository?

https://github.com/topics/ing-diba

Thanks!

Support CSV exports without Balance amounts

Sometimes the Balance (Saldo) amount is missing from the CSV exports, but the ECImporter expects it to be there.

The "Saldo" metadata entry should be made optional.