beancount-gocardless 0.1.8__py3-none-any.whl → 0.1.10__py3-none-any.whl

beancount_gocardless-0.1.10.dist-info/METADATA

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: beancount-gocardless
+Version: 0.1.10
+License-Expression: Unlicense
+License-File: LICENSE
+Requires-Python: <4,>=3.12
+Requires-Dist: beancount
+Requires-Dist: beangulp
+Requires-Dist: pre-commit>=4.5.1
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: requests-cache
+Requires-Dist: rich
+Requires-Dist: textual-dev>=1.7.0
+Requires-Dist: textual>=3.2.0
+Provides-Extra: dev
+Requires-Dist: myst-parser; extra == 'dev'
+Requires-Dist: sphinx; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme; extra == 'dev'
+Provides-Extra: lint
+Requires-Dist: ruff>=0.9.8; extra == 'lint'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
+Description-Content-Type: text/markdown
+
+beancount-gocardless
+====================
+
+GoCardless API client with models manually recreated from swagger spec, plus Beancount importer.
+
+Inspired by https://github.com/tarioch/beancounttools.
+
+Full documentation at https://beancount-gocardless.readthedocs.io/en/latest/.
+
+**Key Features:**
+
+- **API Client:** Models based on swagger spec. Built-in caching via `requests-cache`.
+- **GoCardLess CLI**\: A command-line interface to manage authorization with the GoCardless API:
+
+    - Listing available banks in a specified country (default: GB).
+    - Creating a link to a specific bank using its ID.
+    - Listing authorized accounts.
+    - Deleting an existing link.
+    - Uses environment variables (`GOCARDLESS_SECRET_ID`, `GOCARDLESS_SECRET_KEY`) or command-line arguments for API credentials.
+- **Beancount Importer:**  A `beangulp.Importer` implementation to easily import transactions fetched from the GoCardless API directly into your Beancount ledger.
+
+You'll need to create a GoCardLess account on https://bankaccountdata.gocardless.com/overview/ to get your credentials.
+
+## Development
+
+### API Coverage
+
+The GoCardless client provides **complete API coverage** with Pydantic models for all endpoints and data structures:
+
+**🏦 Core Banking:**
+- **Accounts**: Full account metadata, balances, details, and transactions
+- **Institutions**: Bank/institution information and capabilities
+- **Requisitions**: Bank link management with full lifecycle support
+
+**📋 Agreements & Permissions:**
+- **End User Agreements**: Complete agreement lifecycle management
+- **Access Scopes**: Granular permission control
+- **Reconfirmations**: Agreement renewal workflows
+
+**🔧 Advanced Features:**
+- **Integrations**: Institution capability discovery
+- **Token Management**: JWT token handling (internal)
+- **Pagination**: Full paginated response support
+- **Error Handling**: Error response models
+
+**📊 Rich Data Models:**
+- **Transactions**: Complete transaction details with currency exchange, balances, and metadata
+- **Balances**: Multi-currency balance information with transaction impact
+- **Account Details**: Extensive account information including ownership and addresses
+
+Models manually recreated from the swagger spec, providing type-safe access to every API feature.
+
+**Installation:**
+
+```bash
+pip install beancount-gocardless
+```
+
+**Usage**
+```yaml
+#### gocardless.yaml
+secret_id: $GOCARDLESS_SECRET_ID
+secret_key: $GOCARDLESS_SECRET_KEY
+
+cache_options: # by default, no caching if cache_options is not provided
+  cache_name: "gocardless"
+  backend: "sqlite"
+  expire_after: 3600
+  old_data_on_error: true
+
+accounts:
+    - id: <REDACTED_UUID>
+      asset_account: "Assets:Banks:Revolut:Checking"
+      transaction_types: ["booked", "pending"]  # optional, defaults to both
+```
+
+```python
+#### my.import
+#!/usr/bin/env python
+
+import beangulp
+from beancount_gocardless import GoCardLessImporter
+from smart_importer import apply_hooks, PredictPostings, PredictPayees
+
+importers = [
+    apply_hooks(
+        GoCardLessImporter(),
+        [
+            PredictPostings(),
+            PredictPayees(),
+        ],
+    )
+]
+
+if __name__ == "__main__":
+    ingest = beangulp.Ingest(importers)
+    ingest()
+```
+
+Import your data from GoCardLess's API
+```bash
+python my.import extract ./gocardless.yaml --existing ./ledger.bean
+```

beancount_gocardless-0.1.10.dist-info/RECORD

@@ -0,0 +1,12 @@
+beancount_gocardless/__init__.py,sha256=JVJivGs-o5yY8YGqTYwn1cXY7aiA76lUyc95s1Ye-j0,253
+beancount_gocardless/cli.py,sha256=VDtOhhY5wyuxtXokKlbl1RKZteLR919lParyyspE_qk,2850
+beancount_gocardless/client.py,sha256=eBr3VVrnQIFMwRBmoIC8VN9JvtsDhGZge75nYW7Fyns,15402
+beancount_gocardless/importer.py,sha256=4sh66Vmi8eWEXcmkUIq3UJcqjyZNUitZpkp1-ZcNyCU,16688
+beancount_gocardless/models.py,sha256=H6sqkheJUVpmNaB1U5C6EL0j0y1xfiHC-msq5F2uWBk,18283
+beancount_gocardless/tui.py,sha256=fPI60Tu9n44ZBYLjWbdx88EX4i3kp6S4BQ9p5L9Wtjw,30659
+beancount_gocardless/openapi/swagger.json,sha256=t8TLbt0l2UOyorZX8JyoG4XO2qtXDRYUlsllM3ckyG4,264957
+beancount_gocardless-0.1.10.dist-info/METADATA,sha256=htZDSUk8ne4wb33NSzmHGAsXxBG2tlmhu3kVqxZvOLY,4124
+beancount_gocardless-0.1.10.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+beancount_gocardless-0.1.10.dist-info/entry_points.txt,sha256=_l8n11k9nGPaSDou4atu5NkV0Ojf-qjW2zIIGPzmmgA,128
+beancount_gocardless-0.1.10.dist-info/licenses/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+beancount_gocardless-0.1.10.dist-info/RECORD,,

{beancount_gocardless-0.1.8.dist-info → beancount_gocardless-0.1.10.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.1
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

beancount_gocardless-0.1.10.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+beancount-gocardless = beancount_gocardless.cli:main
+beancount-gocardless-tui = beancount_gocardless.tui:main

beancount_gocardless-0.1.10.dist-info/licenses/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

beancount_gocardless-0.1.8.dist-info/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2018 The Python Packaging Authority
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

beancount_gocardless-0.1.8.dist-info/METADATA

@@ -1,92 +0,0 @@
-Metadata-Version: 2.3
-Name: beancount-gocardless
-Version: 0.1.8
-Summary: 
-License: MIT
-Requires-Python: >=3.12
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: beancount
-Requires-Dist: beangulp
-Requires-Dist: pyyaml
-Requires-Dist: requests
-Requires-Dist: requests-cache
-Description-Content-Type: text/markdown
-
-beancount-gocardless
-====================
-
-This package provides a basic client for interacting with the GoCardless API (formerly Nordigen) and importing your data into Beancount.
-
-This project was inspired by https://github.com/tarioch/beancounttools
-
-Full documentation available at https://beancount-gocardless.readthedocs.io/en/latest/
-
-
-**Key Features:**
-
-- **GoCardless API Client:**  A client for interacting with the GoCardless API. The client has built-in caching via `requests-cache`.
-- **GoCardLess CLI**\: A command-line interface to manage authorization with the GoCardless API:
-
-    - Listing available banks in a specified country (default: GB).
-    - Creating a link to a specific bank using its ID.
-    - Listing authorized accounts.
-    - Deleting an existing link.
-    - Uses environment variables (`NORDIGEN_SECRET_ID`, `NORDIGEN_SECRET_KEY`) or command-line arguments for API credentials.
-- **Beancount Importer:**  A `beangulp.Importer` implementation to easily import transactions fetched from the GoCardless API directly into your Beancount ledger.
-
-You'll need to create a GoCardLess account on https://bankaccountdata.gocardless.com/overview/ to get your credentials.
-
-**Installation:**
-
-```bash
-pip install beancount-gocardless
-```
-
-**Usage**
-```yaml
-#### nordigen.yaml
-secret_id: $NORDIGEN_SECRET_ID
-secret_key: $NORDIGEN_SECRET_KEY
-
-cache_options: # by default, no caching if cache_options is not provided
-  cache_name: "nordigen"
-  backend: "sqlite"
-  expire_after: 3600
-  old_data_on_error: true
-
-accounts:
-    - id: <REDACTED_UUID>
-    asset_account: "Assets:Banks:Revolut:Checking"
-```
-
-```python
-#### my.import
-#!/usr/bin/env python
-
-import beangulp
-from beancount_gocardless import NordigenImporter
-from smart_importer import apply_hooks, PredictPostings, PredictPayees
-
-importers = [
-    apply_hooks(
-        NordigenImporter(),
-        [
-            PredictPostings(),
-            PredictPayees(),
-        ],
-    )
-]
-
-if __name__ == "__main__":
-    ingest = beangulp.Ingest(importers)
-    ingest()
-```
-
-Import your data from Nordigen's API
-```bash
-python my.import extract ./nordigen.yaml --existing ./ledger.bean
-```
-

beancount_gocardless-0.1.8.dist-info/RECORD

@@ -1,9 +0,0 @@
-beancount_gocardless/__init__.py,sha256=Rf2-pfuaXaXPwBu3yEn2uXyOQ6uLyGxljJ5hoTCss5Y,100
-beancount_gocardless/cli.py,sha256=ZdsdknScEOlUq_7rI0ixzN1UDh1dgUokzTzO_3WySqY,2407
-beancount_gocardless/client.py,sha256=g2Px7mcM34ibEAVzbxUtCTVrGWO1sm_CmCL-PXySHro,15764
-beancount_gocardless/importer.py,sha256=tjNKPCYFddR62YDAXm6rfLqcVNeiGKWbVAEyoPWPekg,11151
-beancount_gocardless-0.1.8.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
-beancount_gocardless-0.1.8.dist-info/METADATA,sha256=-WXcAySDk-rankLsjnn9keWLVrrscByJdwl2n1h1bkw,2634
-beancount_gocardless-0.1.8.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-beancount_gocardless-0.1.8.dist-info/entry_points.txt,sha256=fmhiRcNVrum0p30f5YNqvIYVEPXYsS5cP1xNkVmdn8k,70
-beancount_gocardless-0.1.8.dist-info/RECORD,,

beancount_gocardless-0.1.8.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-beancount-gocardless=beancount_gocardless.cli:main
-