beancount-dkb
provides importers for converting CSV exports of DKB (Deutsche
Kreditbank) account summaries to the Beancount format.
$ pip install beancount-dkb
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.
If you're not familiar with how to import external data into Beancount, please read this guide first.
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. The beangulp
examples
suggest using a Python script based on beangulp.Ingest
. Here's an example of how that
might work:
Add an import.py
script in your project root with the following contents:
from beancount_dkb import ECImporter, CreditImporter
from beangulp import Ingest
importers = (
ECImporter(
"DE99 9999 9999 9999 9999 99",
'Assets:DKB:EC',
currency='EUR',
),
CreditImporter(
"9999 9999 9999 9999",
'Assets:DKB:Credit',
currency='EUR',
)
)
if __name__ == "__main__":
ingest = Ingest(importer)
ingest()
... and run it directly using python import.py extract
.
Adjust your config file to include ECImporter
and CreditImporter
(depending on what account you're trying to import).
Add the following to your config.py
.
from beancount_dkb import ECImporter, CreditImporter
CONFIG = [
ECImporter(
"DE99 9999 9999 9999 9999 99",
"Assets:DKB:EC",
currency='EUR',
),
CreditImporter(
"9999 9999 9999 9999",
"Assets:DKB:Credit",
currency='EUR',
)
]
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
By default, the ECImporter prepends the transaction code ("Buchungstext") to the transaction description. To achieve shorter descriptions and use meta tags to query for certain transaction codes, the importer may be configured to store the transaction code in a user provided meta tag.
Add the meta_code
parameter when instantiating an ECImporter
.
from beancount_dkb import ECImporter
from beangulp import Ingest
importers = (
ECImporter(
"DE99 9999 9999 9999 9999 99",
"Assets:DKB:EC",
meta_code="code',
),
)
if __name__ == "__main__":
ingest = Ingest(importer)
ingest()
...
CONFIG = [
ECImporter(
IBAN_NUMBER,
'Assets:DKB:EC',
currency='EUR',
meta_code='code',
),
...
This is how an example transaction looks without the option:
2021-03-01 * "Kartenzahlung" "XY Supermarket"
Assets:DKB:EC -133.72 EUR
And this is the resulting transaction using meta_code='code'
2021-03-01 * "XY Supermarket"
code: Kartenzahlung
Assets:DKB:EC -133.72 EUR
It's possible to give the importer classes hints if you'd like them to include a second posting based on specific characteristics of the original transaction.
For instance, if the payee or the description in a transaction always matches a
certain value, it's possible to tell the ECImporter
or CreditImporter
to
automatically place a second posting in the returned lits of transactions.
ECImporter
accepts payee_patterns
and description_patterns
arguments, which should
be a list of (pattern, account)
tuples.
from beancount_dkb import ECImporter
from beangulp import Ingest
importers = (
ECImporter(
"DE99 9999 9999 9999 9999 99",
"Assets:DKB:EC",
payee_patterns=[
("REWE", "Expenses:Supermarket:REWE"),
("NETFLIX", "Expenses:Online:Netflix"),
],
),
)
if __name__ == "__main__":
ingest = Ingest(importer)
ingest()
CONFIG = [
ECImporter(
IBAN_NUMBER,
"Assets:DKB:EC",
currency='EUR',
payee_patterns=[
("REWE", "Expenses:Supermarket:REWE"),
("NETFLIX", "Expenses:Online:Netflix"),
],
),
CreditImporter
accepts a description_patterns
argument, which should be a list of
(pattern, account)
tuples.
from beancount_dkb import CreditImporter
from beangulp import Ingest
importers = (
ECImporter(
"9999 9999 9999 9999",
"Assets:DKB:EC",
currency="EUR",
payee_patterns=[
("REWE", "Expenses:Supermarket:REWE"),
("NETFLIX", "Expenses:Online:Netflix"),
],
),
)
if __name__ == "__main__":
ingest = Ingest(importer)
ingest()
CONFIG = [
CreditImporter(
CARD_NUMBER,
'Assets:DKB:Credit',
currency='EUR',
description_patterns=[
('REWE', 'Expenses:Supermarket:REWE'),
('NETFLIX', 'Expenses:Online:Netflix'),
],
)
Contributions are most welcome!
Please make sure you have Python 3.9+ and Poetry installed.
- Clone the repository:
git clone https://github.com/siddhantgoel/beancount-dkb
- Install the packages required for development:
poetry install
- That's basically it. You should now be able to run the test suite:
poetry run task test
.