Spendee to Beancount | spendee2beancount

README.md

Spendee to Beancount

This is a simple importer for beancount which imports transactions from a Spendee CSV file export. You may need to modify it to your own needs.

Example usage:

$ bean-extract config.py ./ > spendee.beancount

You will have to open the accounts if you want the transactions to be valid. Additionally, this is a single entry import, and the transactions won't balance out and that's not covered in this gist.

config.py

import os
import sys

sys.path.append(os.path.dirname(__file__))

from spendee import SpendeeImporter

CONFIG = [
    SpendeeImporter(),
]

requirements.txt

beancount
titlecase

spendee.beancount

;; -*- mode: beancount -*-
**** /home/beancount/fava/spendee2beancount/spendee.csv

2023-03-01 * "My Monthly Salary" ""
  Income:Salary  10000.00000000 USD

2023-03-12 * "Walmart" ""
  Expenses:Groceries  154.35000000 USD

spendee.csv

spendee.py

from beancount.core.number import D
from beancount.ingest import importer
from beancount.core import amount
from beancount.core import flags
from beancount.core import data

from dateutil.parser import parse
from titlecase import titlecase

import csv
import os
import re


class SpendeeImporter(importer.ImporterProtocol):
    def __init__(self, expenses_account_prefix: str = 'Expenses', income_account_prefix: str = 'Income'):
        self.expenses_account_prefix = expenses_account_prefix
        self.income_account_prefix = income_account_prefix

    def identify(self, f):
        return re.match('spendee.csv', os.path.basename(f.name))

    def extract(self, file, existing_entries=None):
        entries = []
        with open(file.name, encoding='utf8') as f:
            for index, row in enumerate(csv.DictReader(f)):
                # Type: Expense, Income, Outgoing Transfer, Incoming Transfer
                if row['Type'] in ['Expense', 'Outgoing Transfer']:
                    account_prefix = self.expenses_account_prefix
                elif row['Type'] in ['Income', 'Incoming Transfer']:
                    account_prefix = self.income_account_prefix
                else:
                    # Unknown transaction type
                    continue

                account = f'{account_prefix}:' +  re.sub(r'\W+', '', titlecase(row['Category name'].rstrip()))

                txn = data.Transaction(
                    meta=data.new_metadata(file.name, index),
                    date=parse(row['Date']).date(),
                    flag=flags.FLAG_OKAY,
                    payee=titlecase(row['Note'].rstrip()),
                    narration="",
                    tags=set(),
                    links=set(),
                    postings=[
                        data.Posting(
                            account,
                            amount.Amount(D(row['Amount']), row['Currency']),
                            None, None, None, None
                        )
                    ]
                )
                entries.append(txn)
        return entries