Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/siddhantgoel/beancount-n26
Beancount Importers for N26 CSV Exports
https://github.com/siddhantgoel/beancount-n26
accounting banking beancount finance germany n26 personal-finance plaintext-accounting python python3
Last synced: 12 days ago
JSON representation
Beancount Importers for N26 CSV Exports
- Host: GitHub
- URL: https://github.com/siddhantgoel/beancount-n26
- Owner: siddhantgoel
- License: mit
- Created: 2019-10-21T19:51:58.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T17:30:15.000Z (2 months ago)
- Last Synced: 2024-05-02T02:15:28.915Z (about 2 months ago)
- Topics: accounting, banking, beancount, finance, germany, n26, personal-finance, plaintext-accounting, python, python3
- Language: Python
- Homepage:
- Size: 290 KB
- Stars: 16
- Watchers: 2
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Lists
- awesome-beancount - N26
README
# Beancount N26 Importer
[](https://github.com/siddhantgoel/beancount-n26/workflows/beancount-n26/badge.svg)
[](https://pypi.python.org/pypi/beancount-n26)
[](https://pypi.python.org/pypi/beancount-n26)
[](https://github.com/psf/black)
`beancount-n26` provides a [Beancount] Importer for converting CSV exports of
[N26] account summaries to the Beancount format.
## Installation
```sh
$ 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
```python
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` as follows:
```python
from beancount_n26 import N26Importer
CONFIG = [
N26Importer(
IBAN_NUMBER,
'Assets:N26',
language='en',
file_encoding='utf-8',
account_patterns={
"Expenses:Food:Restaurants": [
"amorino",
"five guys.*",
]
}
),
]
```
The keys should be `accounts` while the items in the list are regular
expressions that should match a `payee`.
Some helper functions in `beancount_n26/utils/patterns_generation.py` are here
to help you generate this dictionnary.
### Multiple-currency transactions
To mark transaction fees associated with multiple-currency transactions, you can
specify the `exchange_fees_account` parameter as follows:
```python
from beancount_n26 import N26Importer
CONFIG = [
N26Importer(
IBAN_NUMBER,
'Assets:N26',
language='en',
file_encoding='utf-8',
exchange_fees_account='Expenses:TransferWise',
),
]
```
With this in place, for transactions where both the amount in EUR and amount in
foreign currency are given, the importer will calculate the transaction fee
based on the exchange rate included in the CSV export and automatically allocate
the value to the account specified in `exchange_fees_account`.
## Contributing
Please make sure you have Python 3.7+ and [Poetry] installed.
1. Git clone the repository -
`git clone https://github.com/siddhantgoel/beancount-n26`
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 py.test`.
[Beancount]: http://furius.ca/beancount/
[N26]: https://n26.com/
[Poetry]: https://poetry.eustace.io/