geldstrom 0.0.1__tar.gz

geldstrom-0.0.1/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+build/
+dist/
+*.egg-info
+env
+.idea/
+*.pyc
+.ruff_cache/
+.pytest_cache/
+.DS_Store
+
+.env
+.venv/
+config/*.env
+
+docs/_deprecated/

geldstrom-0.0.1/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: geldstrom
+Version: 0.0.1
+Summary: German banking API client for account data and transactions
+Author-email: Malte Winckler <malte@nichts-ist-einfach.de>
+License-Expression: LGPL-3.0-only
+Keywords: banking,fints,german-banking,hbci,transactions
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Other Audience
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.13
+Requires-Dist: bleach<6.0,>=5.0
+Requires-Dist: dotenv<1.0.0,>=0.9.9
+Requires-Dist: enum-tools<0.13,>=0.12
+Requires-Dist: mt-940<5.0,>=4.0
+Requires-Dist: pydantic<3.0,>=2.0
+Requires-Dist: requests<3.0,>=2.25
+Requires-Dist: sepaxml<2.2,>=2.1
+Description-Content-Type: text/markdown
+
+# geldstrom
+
+Python package for German banking access and transaction retrieval via FinTS.
+
+This package is developed inside the `geldstrom` uv workspace. Use the repository
+root for day-to-day development commands such as `uv sync`, `uv run pytest`, and
+`uv run ruff`.

geldstrom-0.0.1/README.md

@@ -0,0 +1,7 @@
+# geldstrom
+
+Python package for German banking access and transaction retrieval via FinTS.
+
+This package is developed inside the `geldstrom` uv workspace. Use the repository
+root for day-to-day development commands such as `uv sync`, `uv run pytest`, and
+`uv run ruff`.

geldstrom-0.0.1/geldstrom/__init__.py

@@ -0,0 +1,70 @@
+"""Geldstrom - A pure Python implementation of FinTS 3.0.
+
+This package provides clients for interacting with German banks using
+the FinTS (Financial Transaction Services) protocol.
+
+Quick Start:
+    from geldstrom import FinTS3Client
+
+    with FinTS3Client(
+        bank_code="12345678",
+        server_url="https://banking.example.com/fints",
+        user_id="user123",
+        pin="mypin",
+        product_id="YOUR_PRODUCT_ID",
+    ) as client:
+        for account in client.list_accounts():
+            balance = client.get_balance(account)
+            print(f"{account.iban}: {balance.booked.amount}")
+"""
+
+# --- Client exports (presentation layer) ---
+from geldstrom.clients import FinTS3Client
+
+# --- Domain exports ---
+from geldstrom.domain import (
+    Account,
+    AccountCapabilities,
+    AccountOwner,
+    BalanceAmount,
+    BalanceSnapshot,
+    BankCapabilities,
+    BankCredentials,
+    BankRoute,
+    SessionHandle,
+    SessionToken,
+    TANMethod,
+    TANMethodType,
+    TransactionEntry,
+    TransactionFeed,
+)
+
+# --- Advanced/internal exports ---
+from geldstrom.infrastructure.fints import GatewayCredentials
+
+# Version
+version = "0.0.2"
+__version__ = version
+__all__ = [
+    # Version
+    "version",
+    # Clients
+    "FinTS3Client",
+    # Domain models
+    "Account",
+    "AccountCapabilities",
+    "AccountOwner",
+    "BalanceAmount",
+    "BalanceSnapshot",
+    "BankCapabilities",
+    "BankCredentials",
+    "BankRoute",
+    "SessionHandle",
+    "SessionToken",
+    "TANMethod",
+    "TANMethodType",
+    "TransactionEntry",
+    "TransactionFeed",
+    # Advanced (for from_gateway_credentials)
+    "GatewayCredentials",
+]

geldstrom-0.0.1/geldstrom/clients/__init__.py

@@ -0,0 +1,19 @@
+"""Client layer - public API for interacting with banks.
+
+This module provides the main user-facing clients for FinTS operations.
+Import clients directly from here or from the top-level `geldstrom` package.
+
+Example:
+    from geldstrom.clients import FinTS3Client
+
+    # Or from top level:
+    from geldstrom import FinTS3Client
+"""
+
+from __future__ import annotations
+
+from .fints3 import FinTS3Client
+
+__all__ = [
+    "FinTS3Client",
+]

geldstrom-0.0.1/geldstrom/clients/base.py

@@ -0,0 +1,78 @@
+"""Base types and protocols for FinTS clients.
+
+This module defines the interface that all FinTS client implementations
+should satisfy.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from datetime import date
+from typing import Protocol
+
+from geldstrom.domain import (
+    Account,
+    BalanceSnapshot,
+    BankCapabilities,
+    SessionToken,
+    TransactionFeed,
+)
+from geldstrom.domain.model.tan import TANMethod
+
+
+class BankClient(Protocol):
+    """
+    Protocol defining the interface for a bank client.
+
+    All client implementations should satisfy this protocol.
+    `FinTS3Client` is the primary implementation.
+    """
+
+    def connect(self) -> Sequence[Account]:
+        """Establish connection and fetch account list."""
+        ...
+
+    def disconnect(self) -> None:
+        """Close the session."""
+        ...
+
+    def list_accounts(self) -> Sequence[Account]:
+        """Return available accounts (may trigger connect if needed)."""
+        ...
+
+    def get_balance(self, account: Account | str) -> BalanceSnapshot:
+        """Fetch current balance for an account."""
+        ...
+
+    def get_transactions(
+        self,
+        account: Account | str,
+        start_date: date | None = None,
+        end_date: date | None = None,
+    ) -> TransactionFeed:
+        """Fetch transaction history for an account."""
+        ...
+
+    def get_tan_methods(self) -> Sequence[TANMethod]:
+        """Get available TAN authentication methods."""
+        ...
+
+    @property
+    def session_state(self) -> SessionToken | None:
+        """Current session state for persistence."""
+        ...
+
+    @property
+    def capabilities(self) -> BankCapabilities | None:
+        """Bank's advertised capabilities."""
+        ...
+
+    @property
+    def is_connected(self) -> bool:
+        """Whether the client is currently connected."""
+        ...
+
+
+__all__ = [
+    "BankClient",
+]