Simplify code needed to add a new bank processor

ofx_processor/bpvf_processor/bpvf_cli.py

@@ -1,9 +0,0 @@
-import click
-
-from ofx_processor.bpvf_processor.bpvf_processor import BpvfProcessor
-
-
-@click.command("bpvf", help="Process BPVF bank statement (OFX)")
-@click.argument("ofx_filename")
-def main(ofx_filename):
-    BpvfProcessor(ofx_filename).push_to_ynab()

ofx_processor/ce_processor/ce_cli.py

@@ -1,9 +0,0 @@
-import click
-
-from ofx_processor.ce_processor.ce_processor import CeProcessor
-
-
-@click.command("ce", help="Process CE bank statement (OFX)")
-@click.argument("ofx_filename")
-def main(ofx_filename):
-    CeProcessor(ofx_filename).push_to_ynab()

ofx_processor/ce_processor/ce_processor.py

@@ -1,5 +0,0 @@
-from ofx_processor.bpvf_processor.bpvf_processor import BpvfProcessor
-
-
-class CeProcessor(BpvfProcessor):
-    account_name = "ce"

ofx_processor/processors/bpvf.py

@@ -59,3 +59,9 @@ class BpvfProcessor(Processor):
             sys.exit(1)
 
         return ofx.statements[0].transactions
+
+    @staticmethod
+    @click.command("bpvf", help="Process BPVF bank statement (OFX)")
+    @click.argument("ofx_filename")
+    def main(ofx_filename):
+        BpvfProcessor(ofx_filename).push_to_ynab()

ofx_processor/processors/ce.py

@@ -0,0 +1,13 @@
+import click
+
+from ofx_processor.processors.bpvf import BpvfProcessor
+
+
+class CeProcessor(BpvfProcessor):
+    account_name = "ce"
+
+    @staticmethod
+    @click.command("ce", help="Process CE bank statement (OFX)")
+    @click.argument("ofx_filename")
+    def main(ofx_filename):
+        CeProcessor(ofx_filename).push_to_ynab()

ofx_processor/processors/revolut.py

@@ -1,5 +1,6 @@
 import csv
 
+import click
 import dateparser
 
 from ofx_processor.utils.processor import Processor, Line
@@ -54,3 +55,9 @@ class RevolutProcessor(Processor):
         with open(self.filename) as f:
             reader = csv.DictReader(f, delimiter=";")
             return reader
+
+    @staticmethod
+    @click.command("revolut", help="Process Revolut bank statement (CSV)")
+    @click.argument("csv_filename")
+    def main(csv_filename):
+        RevolutProcessor(csv_filename).push_to_ynab()

ofx_processor/revolut_processor/revolut_cli.py

@@ -1,9 +0,0 @@
-import click
-
-from ofx_processor.revolut_processor.revolut_processor import RevolutProcessor
-
-
-@click.command("revolut", help="Process Revolut bank statement (CSV)")
-@click.argument("csv_filename")
-def main(csv_filename):
-    RevolutProcessor(csv_filename).push_to_ynab()

ofx_processor/utils/utils.py

@@ -3,34 +3,25 @@ import pkgutil
 
 import click
 
-import ofx_processor
+from ofx_processor import processors
 
 
 def discover_processors(cli: click.Group):
     """
-    Discover processors. To be discovered, CLIs need to match the following structure:
+    Discover processors.
 
-    ofx_processor
+    To be discovered, processors must:
-    ├── __init__.py
+    * Be in the `processors` package.
-    └── <package_name>_processor
+    * Declare a <BankName>Processor class
-        ├── __init__.py
+    * Declare a static main function in this class,
-        ├── <module_name>_cli.py
+      which must be a click command
-        └── <module_name>_processor.py
-
-    Preferably, package_name and module_name are the same, but there is no restriction.
-    Finally, a "main" function will be looked for inside the <module_name>_cli module.
-    This function must be a Click command with a unique name and will be added to the
-    main command line interface.
 
     :param cli: The main CLI to add discovered processors to.
     """
-    prefix = ofx_processor.__name__ + "."
+    prefix = processors.__name__ + "."
-    for package in pkgutil.iter_modules(ofx_processor.__path__, prefix):
+    for module in pkgutil.iter_modules(processors.__path__, prefix):
-        if package.name.endswith("_processor"):
+        module = importlib.import_module(module.name)
-            module_prefix = package.name + "."
+        for item in dir(module):
-            package = importlib.import_module(package.name)
+            if item.endswith("Processor") and item != "Processor":
-            for module in pkgutil.iter_modules(package.__path__, module_prefix):
+                cls = getattr(module, item)
-                if module.name.endswith("_cli"):
+                cli.add_command(cls.main)
-                    module = importlib.import_module(module.name)
-                    if "main" in dir(module):
-                        cli.add_command(module.main)

tests/test_bpvf_processor.py

@@ -1,6 +1,6 @@
 import unittest
 
-from ofx_processor.bpvf_processor.bpvf_processor import _process_name_and_memo
+from ofx_processor.processors.bpvf import _process_name_and_memo
 
 
 class MyTestCase(unittest.TestCase):

tests/test_revolut_processor.py

@@ -1,7 +1,7 @@
 import datetime
 import unittest
 
-from ofx_processor.revolut_processor.revolut_processor import (
+from ofx_processor.processors.revolut import (
     _amount_str_to_float,
     RevolutLine,
 )