hamvocke / dkb2homebank Goto Github PK

From c065cb9ebb690829ba0fdffe8f4a44db641b393a Mon Sep 17 00:00:00 2001
From: <timeframe1@gmx.de>
Date: Wed, 29 Dec 2021 21:02:39 +0100
Subject: [PATCH 1/1] added a json file as a config to add categories

---
 .gitignore                    |  1 +
 README.md                     |  3 ++
 dkb2homebank.py               | 20 ++++----
 parse_rules.py                | 96 +++++++++++++++++++++++++++++++++++
 requirements.txt              |  6 +++
 testfiles/category_rules.json | 13 +++++
 6 files changed, 130 insertions(+), 9 deletions(-)
 create mode 100644 parse_rules.py
 create mode 100644 requirements.txt
 create mode 100644 testfiles/category_rules.json

diff --git a/.gitignore b/.gitignore
index ffe7c5a..0381c8c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
 .idea/
 __pycache__/
 *.pyc
+Homebank.csv
\ No newline at end of file
diff --git a/README.md b/README.md
index 754ede1..706b697 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,9 @@ You can also choose an alternative path for your output file, if the standard "c
  
     ./dkb2homebank.py --cash yourCashReportFile.csv --output-file ~/Documents/Finances/import_to_homebank.csv
 
+You can choose to add categories and tags to the new homebank csv file. The source for the parser is a json file. For an example seel `testfiles/category_rules.json`. (This can be archived in HomeBank as well, but a json file is a nice option).
+
+    ./dkb2homebank.py --cash yourCashReportFile.csv -p -pf testfiles/category_rules.json
 
 Importing into Homebank
 -----------------------
diff --git a/dkb2homebank.py b/dkb2homebank.py
index b9092f6..e7b1362 100755
--- a/dkb2homebank.py
+++ b/dkb2homebank.py
@@ -3,6 +3,7 @@
 import argparse
 import csv
 from datetime import datetime
+from parse_rules import ParseRules
 
 
 class DKB(csv.Dialect):
@@ -88,7 +89,7 @@ def identify_account_type(file_handle):
     raise InvalidInputException("Can't recognise account type, is this a valid DKB export CSV?")
 
 
-def convert_DKB_cash(file_handle, output_file="cashHomebank.csv"):
+def convert_DKB_cash(file_handle, parse, output_file="cashHomebank.csv"):
     """
     Convert a DKB cash file (i.e. normal bank account) to a homebank-readable import CSV.
 
@@ -107,12 +108,12 @@ def convert_DKB_cash(file_handle, output_file="cashHomebank.csv"):
                     'payee': row["beguenstigter"],
                     'memo': row["verwendungszweck"],
                     'amount': row["betrag"],
-                    'category': None,
-                    'tags': None
+                    'category': parse.category(row["beguenstigter"], row["verwendungszweck"]),
+                    'tags': parse.tags(row["beguenstigter"], row["verwendungszweck"])
                 })
 
 
-def convert_visa(file_handle, output_file="visaHomebank.csv"):
+def convert_visa(file_handle, parse, output_file="visaHomebank.csv"):
     """
     Convert a DKB visa file to a homebank-readable import CSV.
 
@@ -131,8 +132,8 @@ def convert_visa(file_handle, output_file="visaHomebank.csv"):
                     'payee': None,
                     'memo': row["umsatzbeschreibung"],
                     'amount': row["betrag"],
-                    'category': None,
-                    'tags': None
+                    'category': parse.category(row["beguenstigter"], row["verwendungszweck"]),
+                    'tags': parse.tags(row["beguenstigter"], row["verwendungszweck"])
                 })
 
 
@@ -171,6 +172,7 @@ def setup_parser():
     group.add_argument("-v", "--visa", action="store_true", help="convert a DKB Visa account CSV file")
     group.add_argument("-c", "--cash", action="store_true", help="convert a DKB Cash account CSV file")
 
+    parser.add_argument("-p", "--parse_file", help="JSON file to parse categories and tags from keywords")
     parser.add_argument('-o', '--output-file', default='Homebank.csv',
                         help='choose where to store the output file (default: working directory')
 
@@ -182,16 +184,16 @@ def setup_parser():
 def main():
 
     args = setup_parser()
-
+    parse = ParseRules(args.parse_file)
     with open(args.filename, 'r', encoding='iso-8859-1') as csv_file:
         account_type = identify_account_type(csv_file)
         if "visa" == account_type or args.visa:
             output = args.output_file or "visaHomebank.csv"
-            convert_visa(csv_file, output)
+            convert_visa(csv_file, parse, output)
             print(f"DKB Visa file converted. Output file: {output}") if args.debug else None
         elif "cash" == account_type or args.cash:
             output = args.output_file or "cashHomebank.csv"
-            convert_DKB_cash(csv_file, output)
+            convert_DKB_cash(csv_file, parse, output)
             print(f"DKB Cash file converted. Output file: {output}") if args.debug else None
 
 
diff --git a/parse_rules.py b/parse_rules.py
new file mode 100644
index 0000000..28cce96
--- /dev/null
+++ b/parse_rules.py
@@ -0,0 +1,96 @@
+import json
+import re
+import jsonschema
+from jsonschema import validate
+
+
+class ParseRules:
+    category_rules_schema = {
+        "definitions":
+        {
+            "rule":
+            {
+                "properties":
+                {
+                    "key_word": {
+                        "type": "string"
+                    },
+                    "conditions": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    }
+                },
+                "required": ["key_word", "conditions"],
+                "additionalProperties": False
+            }
+        },
+
+        "type": "object",
+        "required": ["categories", "tags"],
+        "additionalProperties": False,
+        "properties":
+        {
+            "categories":
+            {
+                "type": "array",
+                "categories": {"$ref": "#/definitions/rule"}
+            },
+            "tags":
+            {
+                "type": "array",
+                "tags": {"$ref": "#/definitions/rule"}
+            }
+        }
+    }
+
+    def __init__(self, parse_file):
+        self.valide_json = False
+        if parse_file is not None:
+            self.json_file = open(parse_file)
+            self.__load_and_validate_jason()
+
+    def __del__(self):
+        if 'json_file' in locals():
+            self.json_file.close()
+
+    def __load_and_validate_jason(self):
+        try:
+            self.category_rules = json.load(self.json_file)
+            self.valide_json = True
+        except ValueError as err:
+            print(err)
+            self.valide_json = False
+        try:
+            validate(instance=self.category_rules, schema=self.category_rules_schema)
+            self.valide_json = True
+        except jsonschema.exceptions.ValidationError as err:
+            print(err)
+            self.valide_json = False
+
+    def category(self, payee, memo):
+        if self.valide_json:
+            return self.__apply_rule(self.category_rules['categories'], payee, memo, True)
+        else:
+            return None
+
+    def tags(self, payee, memo):
+        if self.valide_json:
+            return self.__apply_rule(self.category_rules['tags'], payee, memo, False)
+        else:
+            return None
+
+    def __apply_rule(self, rules, payee, memo, apply_once):
+        tags = []
+        for rule in rules:
+            for condition in rule['conditions']:
+                if bool(re.search(condition, payee + ' ' + memo, re.IGNORECASE)):
+                    if apply_once:
+                        return rule['key_word']
+                    else:
+                        tags.append(rule['key_word'])
+                        break
+        if tags:
+            return ",".join(tags)
+        return None
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..f8a4684
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,6 @@
+argparse
+csv
+datetime 
+json
+re
+jsonschema
\ No newline at end of file
diff --git a/testfiles/category_rules.json b/testfiles/category_rules.json
new file mode 100644
index 0000000..f940f6c
--- /dev/null
+++ b/testfiles/category_rules.json
@@ -0,0 +1,13 @@
+{
+    "categories": [{
+        "key_word": "test_category",
+        "conditions": ["foo", "shop"]
+    }],
+    "tags": [{
+        "key_word": "test_tag",
+        "conditions": ["shop"]
+    }, {
+        "key_word": "test_tag_2",
+        "conditions": ["shop"]
+    }]
+}
\ No newline at end of file
-- 
2.25.1