ofxstatement-nordigen 0.1__py3-none-any.whl

ofxstatement_nordigen/plugin.py

@@ -0,0 +1,61 @@
+import json
+from typing import Iterable
+
+from ofxstatement.plugin import Plugin
+from ofxstatement.parser import StatementParser
+from ofxstatement.statement import Statement, StatementLine
+
+from ofxstatement_nordigen.schemas import NordigenTransactionModel
+
+
+class NordigenPlugin(Plugin):
+    """Retrieves Nordigen transactions and converts them to OFX format."""
+
+    def get_parser(self, filename: str) -> "NordigenParser":
+        return NordigenParser(filename)
+
+
+class NordigenParser(StatementParser[str]):
+    def __init__(self, filename: str) -> None:
+        super().__init__()
+        if not filename.endswith(".json"):
+            raise ValueError("Only JSON files are supported")
+        self.filename = filename
+
+    def parse(self) -> Statement:
+        """Main entry point for parsers
+
+        super() implementation will call to split_records and parse_record to
+        process the file.
+        """
+        with open(self.filename, "r"):
+            return super().parse()
+
+    def split_records(self) -> Iterable[str]:
+        """Return iterable object consisting of a line per transaction"""
+        data = json.load(open(self.filename, "r"))
+        transactions = data.get("transactions", {})
+        booked_transactions = transactions.get("booked", [])
+        return [json.dumps(transaction) for transaction in booked_transactions]
+
+    def parse_record(self, line: str) -> StatementLine:
+        """Parse given transaction line and return StatementLine object"""
+
+        # TODO: Infer transaction type from transaction data
+        statement = StatementLine()
+        transaction = json.loads(line)
+        transaction_data = NordigenTransactionModel(**transaction)
+        statement.id = transaction_data.transactionId
+        statement.date = transaction_data.bookingDateTime
+        statement.amount = transaction_data.transactionAmount.amount
+        statement.memo = transaction_data.remittanceInformationUnstructured
+        statement.payee = transaction_data.creditorName or transaction_data.debtorName
+        statement.date_user = transaction_data.valueDateTime
+        statement.check_no = transaction_data.checkId
+        statement.refnum = transaction_data.internalTransactionId
+        statement.currency = transaction_data.transactionAmount.currency
+        if transaction_data.currencyExchange and hasattr(
+            transaction_data.currencyExchange, "sourceCurrency"
+        ):
+            statement.orig_currency = transaction_data.currencyExchange.sourceCurrency
+        return statement

ofxstatement_nordigen/schemas.py

@@ -0,0 +1,79 @@
+from __future__ import annotations
+
+import datetime
+from ofxstatement.statement import Currency
+from decimal import Decimal
+from typing import List, Optional, Union
+
+from pydantic import BaseModel, field_validator
+
+
+class Amount(BaseModel):
+    amount: Decimal
+    currency: Currency
+
+    class Config:
+        arbitrary_types_allowed = True
+
+    @field_validator("currency", mode="before")
+    def validate_currency(cls, value):
+        if isinstance(value, str):
+            return Currency(value)
+        return value
+
+
+class InstructedAmount(Amount):
+    targetCurrency: Optional[Currency] = None
+    sourceCurrency: Optional[Currency] = None
+    exchangeRate: Optional[float] = None
+
+    @field_validator("targetCurrency", "sourceCurrency", mode="before")
+    def validate_currency(cls, value):
+        if isinstance(value, str):
+            return Currency(value)
+        return value
+
+
+class Account(BaseModel):
+    bban: Optional[str] = None
+
+
+class ReportExchangeRate(BaseModel):
+    instructedAmount: Optional[InstructedAmount] = None
+
+
+class NordigenTransactionModel(BaseModel):
+    """
+    Nordigen data transaction model.
+    """
+
+    balanceAfterTransaction: Optional[float] = None
+    bankTransactionCode: Optional[str] = None
+    bookingDate: Optional[datetime.date] = None
+    bookingDateTime: Optional[datetime.datetime] = None
+    checkId: Optional[str] = None
+    creditorAccount: Optional[Account] = None
+    creditorAgent: Optional[str] = None
+    creditorId: Optional[str] = None
+    creditorName: Optional[str] = None
+    currencyExchange: Optional[Union[ReportExchangeRate, InstructedAmount]] = None
+    debtorAccount: Optional[Account] = None
+    debtorAgent: Optional[str] = None
+    debtorName: Optional[str] = None
+    endToEndId: Optional[str] = None
+    entryReference: Optional[str] = None
+    internalTransactionId: Optional[str] = None
+    mandateId: Optional[str] = None
+    merchantCategoryCode: Optional[str] = None
+    proprietaryBankTransactionCode: Optional[str] = None
+    purposeCode: Optional[str] = None
+    remittanceInformationStructured: Optional[str] = None
+    remittanceInformationStructuredArray: Optional[List[str]] = None
+    remittanceInformationUnstructured: Optional[str] = None
+    remmittanceInformationUnstructuredArray: Optional[List[str]] = None
+    transactionAmount: Amount
+    transactionId: Optional[str] = None
+    ultimateCreditor: Optional[str] = None
+    ultimateDebtor: Optional[str] = None
+    valueDate: Optional[datetime.date] = None
+    valueDateTime: Optional[datetime.datetime] = None

ofxstatement_nordigen-0.1.dist-info/METADATA

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: ofxstatement-nordigen
+Version: 0.1
+Summary: ofxstatement plugin for Nordigen bank statements
+Author-email: Jimmy Stammers <jimmy.stammers@gmail.com>
+Project-URL: Homepage, https://github.com/jstammers/ofxstatement-nordigen/
+Keywords: ofx,banking,statement,plugin,ofxstatement
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Natural Language :: English
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Classifier: Topic :: Utilities
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+Requires-Dist: ofxstatement
+Requires-Dist: pydantic
+Requires-Dist: requests
+Requires-Dist: requests-cache
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ofxstatement-nordigen
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A plugin for `ofxstatement`_ to parse transaction data from GoCardless (previously known as Nordigen).
+
+`ofxstatement`_ is a tool to convert proprietary bank statement to OFX format,
+suitable for importing to GnuCash. Plugin for ofxstatement parses a
+particular proprietary bank statement format and produces common data
+structure, that is then formatted into an OFX file.
+
+.. _ofxstatement: https://github.com/kedder/ofxstatement
+
+
+Installation
+================
+
+To install the plugin, you can use `pip`_:
+
+.. _pip: https://pypi.org/project/pip/
+
+.. code-block:: shell
+
+    pip install ofxstatement-nordigen
+
+or, if you want to install it in editable mode (for development), use:
+
+.. code-block:: shell
+
+    pip install -e ./
+
+To verify that the plugin is installed correctly, you can run:
+
+.. code-block:: shell
+
+    ofxstatement --list-plugins
+
+This should list the `nordigen` plugin among other plugins.
+
+Usage
+================
+
+To use the plugin, you can run the `ofxstatement` command with the `--plugin` option:
+
+.. code-block:: shell
+
+    ofxstatement convert -t nordigen <input_file> <output_file>
+
+Replace `<input_file>` with the path to your input file and `<output_file>` with the desired output file name.
+
+The input file should be a JSON of transactions from GoCardless that has the schema defined `here`_.
+
+.. _here: https://developer.gocardless.com/bank-account-data/transactions
+
+The output file will be an OFX file that can be imported into GnuCash or other financial software.
+
+After you are done
+==================
+
+After your plugin is ready, feel free to open an issue on `ofxstatement`_
+project to include your plugin in "known plugin list". That would hopefully
+make life of other clients of your bank easier.

ofxstatement_nordigen-0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+ofxstatement_nordigen/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ofxstatement_nordigen/plugin.py,sha256=P74OSBt-4SkXHuHa0MREMayd9Um_mwp0jKgPndMAhb0,2533
+ofxstatement_nordigen/schemas.py,sha256=8n4iXQjnHHHrKF_ZdEJRs6zcKCbidWu61PQmyVfzUUI,2561
+ofxstatement_nordigen-0.1.dist-info/METADATA,sha256=QNFTJR7YfNTr3Oiu2K06SFsRezFSaDIccqF0wSW0A1M,2676
+ofxstatement_nordigen-0.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+ofxstatement_nordigen-0.1.dist-info/entry_points.txt,sha256=u2VbBVZyOs-NBZwsS0wBZMwiczusBhgkWBrhSrcckvA,70
+ofxstatement_nordigen-0.1.dist-info/top_level.txt,sha256=gxcEQgvstWr0jhEqaT70JODD71i507SJ06YeA5KIUj4,22
+ofxstatement_nordigen-0.1.dist-info/RECORD,,

ofxstatement_nordigen-0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (78.1.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ofxstatement_nordigen-0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[ofxstatement]
+nordigen = ofxstatement_nordigen.plugin:NordigenPlugin

ofxstatement_nordigen-0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+ofxstatement_nordigen