beancount-gocardless 0.1.13__py3-none-any.whl → 0.1.14__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,108 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: beancount-gocardless
3
- Version: 0.1.13
4
- License-Expression: Unlicense
5
- License-File: LICENSE
6
- Requires-Python: <4,>=3.12
7
- Requires-Dist: beancount
8
- Requires-Dist: beangulp
9
- Requires-Dist: pre-commit>=4.5.1
10
- Requires-Dist: pydantic>=2.0.0
11
- Requires-Dist: pyyaml
12
- Requires-Dist: requests
13
- Requires-Dist: requests-cache
14
- Requires-Dist: rich
15
- Requires-Dist: textual-dev>=1.7.0
16
- Requires-Dist: textual>=3.2.0
17
- Provides-Extra: dev
18
- Requires-Dist: myst-parser; extra == 'dev'
19
- Requires-Dist: sphinx; extra == 'dev'
20
- Requires-Dist: sphinx-rtd-theme; extra == 'dev'
21
- Provides-Extra: lint
22
- Requires-Dist: ruff>=0.9.8; extra == 'lint'
23
- Provides-Extra: test
24
- Requires-Dist: pytest; extra == 'test'
25
- Requires-Dist: pytest-asyncio; extra == 'test'
26
- Description-Content-Type: text/markdown
27
-
28
- beancount-gocardless
29
- ====================
30
-
31
- GoCardless API client with models manually recreated from swagger spec, plus Beancount importer.
32
-
33
- Inspired by https://github.com/tarioch/beancounttools.
34
-
35
- Full documentation at https://beancount-gocardless.readthedocs.io/en/latest/.
36
-
37
- **Key Features:**
38
-
39
- - **API Client:** Models based on swagger spec. Built-in caching via `requests-cache`.
40
- - **GoCardLess CLI**\: A command-line interface to manage authorization with the GoCardless API:
41
-
42
- - Listing available banks in a specified country (default: GB).
43
- - Creating a link to a specific bank using its ID.
44
- - Listing authorized accounts.
45
- - Deleting an existing link.
46
- - Uses environment variables (`GOCARDLESS_SECRET_ID`, `GOCARDLESS_SECRET_KEY`) or command-line arguments for API credentials.
47
- - **Beancount Importer:** A `beangulp.Importer` implementation to easily import transactions fetched from the GoCardless API directly into your Beancount ledger.
48
-
49
- You'll need to create a GoCardLess account on https://bankaccountdata.gocardless.com/overview/ to get your credentials.
50
-
51
- ## Development
52
-
53
- ### API Coverage
54
-
55
- The GoCardless client tries to provide complete API coverage with Pydantic models for all endpoints and data structures.
56
- Models are manually recreated from the swagger spec, providing type-safe access to every API feature.
57
-
58
- **Installation:**
59
-
60
- ```bash
61
- pip install beancount-gocardless
62
- ```
63
-
64
- **Usage**
65
- ```yaml
66
- #### gocardless.yaml
67
- secret_id: $GOCARDLESS_SECRET_ID
68
- secret_key: $GOCARDLESS_SECRET_KEY
69
-
70
- cache_options: # by default, no caching if cache_options is not provided
71
- cache_name: "gocardless"
72
- backend: "sqlite"
73
- expire_after: 3600
74
- old_data_on_error: true
75
-
76
- accounts:
77
- - id: <REDACTED_UUID>
78
- asset_account: "Assets:Banks:Revolut:Checking"
79
- transaction_types: ["booked", "pending"] # optional list, defaults to both
80
- preferred_balance_type: "interimAvailable" # optional, use specific balance type
81
- ```
82
-
83
- ```python
84
- #### my.import
85
- #!/usr/bin/env python
86
-
87
- import beangulp
88
- from beancount_gocardless import GoCardLessImporter
89
- from smart_importer import PredictPostings, PredictPayees
90
-
91
- importers = [
92
- GoCardLessImporter()
93
- ]
94
-
95
- hooks = [
96
- PredictPostings().hook,
97
- PredictPayees().hook,
98
- ]
99
-
100
- if __name__ == "__main__":
101
- ingest = beangulp.Ingest(importers, hooks=hooks)
102
- ingest()
103
- ```
104
-
105
- Import your data from GoCardLess's API
106
- ```bash
107
- python my.import extract ./gocardless.yaml --existing ./ledger.bean
108
- ```
@@ -1,12 +0,0 @@
1
- beancount_gocardless/__init__.py,sha256=JVJivGs-o5yY8YGqTYwn1cXY7aiA76lUyc95s1Ye-j0,253
2
- beancount_gocardless/cli.py,sha256=EDa01K1-E7e_Y0mHyISR4oimlo_nh5mLlE0RbhEFDAQ,4775
3
- beancount_gocardless/client.py,sha256=2Sl8yeS7Lb1Y9qH8lZfGYrIVI_wkKy7ckZHG0GLE30Y,15572
4
- beancount_gocardless/importer.py,sha256=RHKvhB1VA7WHpk_Az-HXxUfFIsycz8dRvdsrKoJqAMI,17068
5
- beancount_gocardless/models.py,sha256=tQyzEvqs9_7NmyCi3fZdEUxy5_rTo8VSoFsg7mupLh8,19351
6
- beancount_gocardless/tui.py,sha256=Tk5AN0PeZZfXlQqm81P5Bmtdx-_whUyuKSsBv4eiF5w,26409
7
- beancount_gocardless/openapi/swagger.json,sha256=t8TLbt0l2UOyorZX8JyoG4XO2qtXDRYUlsllM3ckyG4,264957
8
- beancount_gocardless-0.1.13.dist-info/METADATA,sha256=6Bocz1344DLizkXbivAS_b_fRnnw29hj5DeAPPzoqX8,3229
9
- beancount_gocardless-0.1.13.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
10
- beancount_gocardless-0.1.13.dist-info/entry_points.txt,sha256=_l8n11k9nGPaSDou4atu5NkV0Ojf-qjW2zIIGPzmmgA,128
11
- beancount_gocardless-0.1.13.dist-info/licenses/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
12
- beancount_gocardless-0.1.13.dist-info/RECORD,,
@@ -1,24 +0,0 @@
1
- This is free and unencumbered software released into the public domain.
2
-
3
- Anyone is free to copy, modify, publish, use, compile, sell, or
4
- distribute this software, either in source code form or as a compiled
5
- binary, for any purpose, commercial or non-commercial, and by any
6
- means.
7
-
8
- In jurisdictions that recognize copyright laws, the author or authors
9
- of this software dedicate any and all copyright interest in the
10
- software to the public domain. We make this dedication for the benefit
11
- of the public at large and to the detriment of our heirs and
12
- successors. We intend this dedication to be an overt act of
13
- relinquishment in perpetuity of all present and future rights to this
14
- software under copyright law.
15
-
16
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19
- IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20
- OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21
- ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22
- OTHER DEALINGS IN THE SOFTWARE.
23
-
24
- For more information, please refer to <https://unlicense.org>