Beancount Importer for N26 CSV exports
Project description
Beancount N26 Importer
beancount-n26
provides a Beancount Importer for converting CSV exports of
N26 account summaries to the Beancount format.
Installation
$ pip install beancount-n26
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.
Usage
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. 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_n26 import N26Importer
from beangulp import Ingest
importers = (
N26Importer(
IBAN_NUMBER,
'Assets:N26',
language='en',
file_encoding='utf-8',
),
)
if __name__ == "__main__":
ingest = Ingest(importer)
ingest()
... and run it directly using python import.py extract
.
Beancount 2.x
Add the following to your config.py
.
from beancount_n26 import N26Importer
CONFIG = [
N26Importer(
IBAN_NUMBER,
'Assets:N26',
language='en',
file_encoding='utf-8',
),
]
Classification
To classify specific recurring transactions automatically, you can specify an
account_patterns
parameter. The key should be the account name and the items in the
list are regular expressions that should match a payee
.
A few helper functions have been provided in
beancount_n26/utils/patterns_generation.py
to help you generate this dictionnary.
Beancount 3.x
from beancount_n26 import N26Importer
from beangulp import Ingest
importers = (
N26Importer(
IBAN_NUMBER,
'Assets:N26',
account_patterns={"Expenses:Supermarket": ["REWE", "ALDI"]}
),
)
if __name__ == "__main__":
ingest = Ingest(importer)
ingest()
Beancount 2.x
from beancount_n26 import N26Importer
CONFIG = [
N26Importer(
...
account_patterns={"Expenses:Supermarket": ["REWE", "ALDI"]}
),
]
Contributing
Please make sure you have Python 3.9+ and Poetry installed.
-
Git clone the repository -
git clone https://github.com/siddhantgoel/beancount-n26
-
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
.