transtractor 0.9.0__tar.gz

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.
Files changed (177) hide show
  1. transtractor-0.9.0/.github/workflows/CI.yml +179 -0
  2. transtractor-0.9.0/.github/workflows/tests.yml +58 -0
  3. transtractor-0.9.0/.gitignore +210 -0
  4. transtractor-0.9.0/.readthedocs.yaml +22 -0
  5. transtractor-0.9.0/Cargo.lock +503 -0
  6. transtractor-0.9.0/Cargo.toml +17 -0
  7. transtractor-0.9.0/LICENSE +7 -0
  8. transtractor-0.9.0/PKG-INFO +104 -0
  9. transtractor-0.9.0/README.md +72 -0
  10. transtractor-0.9.0/data/configs/au/cba__credit_card__1.json +60 -0
  11. transtractor-0.9.0/data/configs/au/cba__debit__1.json +64 -0
  12. transtractor-0.9.0/data/configs/au/cba__loan__1.json +61 -0
  13. transtractor-0.9.0/data/configs/au/nab__classic_banking__1.json +70 -0
  14. transtractor-0.9.0/docs/Makefile +20 -0
  15. transtractor-0.9.0/docs/api_reference.rst +43 -0
  16. transtractor-0.9.0/docs/conf.py +36 -0
  17. transtractor-0.9.0/docs/configuration.rst +613 -0
  18. transtractor-0.9.0/docs/index.rst +94 -0
  19. transtractor-0.9.0/docs/installation.rst +47 -0
  20. transtractor-0.9.0/docs/make.bat +35 -0
  21. transtractor-0.9.0/docs/requirements.txt +2 -0
  22. transtractor-0.9.0/docs/supported_statements.rst +38 -0
  23. transtractor-0.9.0/pyproject.toml +47 -0
  24. transtractor-0.9.0/python/transtractor/__init__.py +5 -0
  25. transtractor-0.9.0/python/transtractor/exceptions.py +6 -0
  26. transtractor-0.9.0/python/transtractor/parser.py +138 -0
  27. transtractor-0.9.0/python/transtractor/structs/__init__.py +0 -0
  28. transtractor-0.9.0/python/transtractor/structs/statement_data.py +203 -0
  29. transtractor-0.9.0/python/transtractor/structs/transaction.py +42 -0
  30. transtractor-0.9.0/python/transtractor/transtractor.pyi +208 -0
  31. transtractor-0.9.0/python/transtractor/utils/__init__.py +0 -0
  32. transtractor-0.9.0/python/transtractor/utils/default_configs.py +25 -0
  33. transtractor-0.9.0/python/transtractor/utils/extract.py +27 -0
  34. transtractor-0.9.0/python/transtractor/utils/testing.py +194 -0
  35. transtractor-0.9.0/src/checkers/balances.rs +363 -0
  36. transtractor-0.9.0/src/checkers/fields.rs +119 -0
  37. transtractor-0.9.0/src/checkers/mod.rs +13 -0
  38. transtractor-0.9.0/src/configs/db.rs +124 -0
  39. transtractor-0.9.0/src/configs/mod.rs +3 -0
  40. transtractor-0.9.0/src/configs/typer.rs +150 -0
  41. transtractor-0.9.0/src/configs/validate/account_examples.rs +12 -0
  42. transtractor-0.9.0/src/configs/validate/account_number_alignment.rs +13 -0
  43. transtractor-0.9.0/src/configs/validate/account_number_alignment_tol.rs +13 -0
  44. transtractor-0.9.0/src/configs/validate/account_number_patterns.rs +13 -0
  45. transtractor-0.9.0/src/configs/validate/account_number_terms.rs +12 -0
  46. transtractor-0.9.0/src/configs/validate/account_terms.rs +12 -0
  47. transtractor-0.9.0/src/configs/validate/account_type.rs +20 -0
  48. transtractor-0.9.0/src/configs/validate/bank_name.rs +12 -0
  49. transtractor-0.9.0/src/configs/validate/closing_balance_alignment.rs +13 -0
  50. transtractor-0.9.0/src/configs/validate/closing_balance_alignment_tol.rs +13 -0
  51. transtractor-0.9.0/src/configs/validate/closing_balance_formats.rs +12 -0
  52. transtractor-0.9.0/src/configs/validate/closing_balance_terms.rs +12 -0
  53. transtractor-0.9.0/src/configs/validate/fix_text_order.rs +13 -0
  54. transtractor-0.9.0/src/configs/validate/key.rs +174 -0
  55. transtractor-0.9.0/src/configs/validate/mod.rs +112 -0
  56. transtractor-0.9.0/src/configs/validate/opening_balance_alignment.rs +13 -0
  57. transtractor-0.9.0/src/configs/validate/opening_balance_alignment_tol.rs +13 -0
  58. transtractor-0.9.0/src/configs/validate/opening_balance_formats.rs +12 -0
  59. transtractor-0.9.0/src/configs/validate/opening_balance_terms.rs +12 -0
  60. transtractor-0.9.0/src/configs/validate/start_date_alignment.rs +13 -0
  61. transtractor-0.9.0/src/configs/validate/start_date_alignment_tol.rs +13 -0
  62. transtractor-0.9.0/src/configs/validate/start_date_formats.rs +12 -0
  63. transtractor-0.9.0/src/configs/validate/start_date_terms.rs +12 -0
  64. transtractor-0.9.0/src/configs/validate/transaction_alignment_tol.rs +13 -0
  65. transtractor-0.9.0/src/configs/validate/transaction_amount_alignment.rs +13 -0
  66. transtractor-0.9.0/src/configs/validate/transaction_amount_formats.rs +12 -0
  67. transtractor-0.9.0/src/configs/validate/transaction_amount_headers.rs +12 -0
  68. transtractor-0.9.0/src/configs/validate/transaction_amount_invert_alignment.rs +13 -0
  69. transtractor-0.9.0/src/configs/validate/transaction_amount_invert_headers.rs +12 -0
  70. transtractor-0.9.0/src/configs/validate/transaction_balance_alignment.rs +13 -0
  71. transtractor-0.9.0/src/configs/validate/transaction_balance_formats.rs +15 -0
  72. transtractor-0.9.0/src/configs/validate/transaction_balance_headers.rs +12 -0
  73. transtractor-0.9.0/src/configs/validate/transaction_date_alignment.rs +13 -0
  74. transtractor-0.9.0/src/configs/validate/transaction_date_formats.rs +12 -0
  75. transtractor-0.9.0/src/configs/validate/transaction_date_headers.rs +12 -0
  76. transtractor-0.9.0/src/configs/validate/transaction_description_alignment.rs +13 -0
  77. transtractor-0.9.0/src/configs/validate/transaction_description_headers.rs +12 -0
  78. transtractor-0.9.0/src/configs/validate/transaction_formats.rs +14 -0
  79. transtractor-0.9.0/src/configs/validate/transaction_new_line_tol.rs +13 -0
  80. transtractor-0.9.0/src/configs/validate/transaction_terms.rs +12 -0
  81. transtractor-0.9.0/src/configs/validate/transaction_terms_stop.rs +12 -0
  82. transtractor-0.9.0/src/configs/validate/utils/alignment.rs +22 -0
  83. transtractor-0.9.0/src/configs/validate/utils/amount_formats.rs +15 -0
  84. transtractor-0.9.0/src/configs/validate/utils/date_formats.rs +15 -0
  85. transtractor-0.9.0/src/configs/validate/utils/iso_3166_1_alpha_2.rs +345 -0
  86. transtractor-0.9.0/src/configs/validate/utils/mod.rs +15 -0
  87. transtractor-0.9.0/src/configs/validate/utils/patterns.rs +23 -0
  88. transtractor-0.9.0/src/configs/validate/utils/terms.rs +17 -0
  89. transtractor-0.9.0/src/configs/validate/utils/tolerance.rs +7 -0
  90. transtractor-0.9.0/src/fixers/amounts.rs +154 -0
  91. transtractor-0.9.0/src/fixers/closing_balance.rs +198 -0
  92. transtractor-0.9.0/src/fixers/date.rs +249 -0
  93. transtractor-0.9.0/src/fixers/implicit_balance.rs +225 -0
  94. transtractor-0.9.0/src/fixers/implicit_date.rs +223 -0
  95. transtractor-0.9.0/src/fixers/mod.rs +31 -0
  96. transtractor-0.9.0/src/fixers/opening_balance.rs +286 -0
  97. transtractor-0.9.0/src/fixers/set_indices.rs +203 -0
  98. transtractor-0.9.0/src/fixers/transaction_order.rs +173 -0
  99. transtractor-0.9.0/src/formats/amount/format1.rs +50 -0
  100. transtractor-0.9.0/src/formats/amount/format2.rs +50 -0
  101. transtractor-0.9.0/src/formats/amount/format3.rs +52 -0
  102. transtractor-0.9.0/src/formats/amount/format4.rs +51 -0
  103. transtractor-0.9.0/src/formats/amount/format5.rs +31 -0
  104. transtractor-0.9.0/src/formats/amount/mod.rs +108 -0
  105. transtractor-0.9.0/src/formats/date/format1.rs +56 -0
  106. transtractor-0.9.0/src/formats/date/format2.rs +50 -0
  107. transtractor-0.9.0/src/formats/date/format3.rs +52 -0
  108. transtractor-0.9.0/src/formats/date/format4.rs +52 -0
  109. transtractor-0.9.0/src/formats/date/format5.rs +54 -0
  110. transtractor-0.9.0/src/formats/date/generate.rs +114 -0
  111. transtractor-0.9.0/src/formats/date/mod.rs +276 -0
  112. transtractor-0.9.0/src/formats/mod.rs +5 -0
  113. transtractor-0.9.0/src/lib.rs +22 -0
  114. transtractor-0.9.0/src/parsers/base/amount.rs +154 -0
  115. transtractor-0.9.0/src/parsers/base/date.rs +116 -0
  116. transtractor-0.9.0/src/parsers/base/mod.rs +12 -0
  117. transtractor-0.9.0/src/parsers/base/primer.rs +121 -0
  118. transtractor-0.9.0/src/parsers/base/value.rs +262 -0
  119. transtractor-0.9.0/src/parsers/flows/config_json_file_to_config.rs +164 -0
  120. transtractor-0.9.0/src/parsers/flows/mod.rs +5 -0
  121. transtractor-0.9.0/src/parsers/flows/text_items_to_debug.rs +35 -0
  122. transtractor-0.9.0/src/parsers/flows/text_items_to_layout.rs +52 -0
  123. transtractor-0.9.0/src/parsers/flows/text_items_to_statement_data.rs +70 -0
  124. transtractor-0.9.0/src/parsers/flows/text_items_to_statement_datas.rs +32 -0
  125. transtractor-0.9.0/src/parsers/mod.rs +5 -0
  126. transtractor-0.9.0/src/parsers/primed/amount.rs +212 -0
  127. transtractor-0.9.0/src/parsers/primed/date.rs +186 -0
  128. transtractor-0.9.0/src/parsers/primed/mod.rs +7 -0
  129. transtractor-0.9.0/src/parsers/primed/value.rs +358 -0
  130. transtractor-0.9.0/src/parsers/statement/account_number.rs +338 -0
  131. transtractor-0.9.0/src/parsers/statement/closing_balance.rs +148 -0
  132. transtractor-0.9.0/src/parsers/statement/mod.rs +11 -0
  133. transtractor-0.9.0/src/parsers/statement/opening_balance.rs +151 -0
  134. transtractor-0.9.0/src/parsers/statement/start_date.rs +133 -0
  135. transtractor-0.9.0/src/parsers/statement/transaction.rs +365 -0
  136. transtractor-0.9.0/src/parsers/transaction/amount.rs +200 -0
  137. transtractor-0.9.0/src/parsers/transaction/balance.rs +140 -0
  138. transtractor-0.9.0/src/parsers/transaction/date.rs +147 -0
  139. transtractor-0.9.0/src/parsers/transaction/description.rs +131 -0
  140. transtractor-0.9.0/src/parsers/transaction/mod.rs +10 -0
  141. transtractor-0.9.0/src/parsers/transaction/utils/get_all_fields.rs +133 -0
  142. transtractor-0.9.0/src/parsers/transaction/utils/get_compulsory_fields.rs +79 -0
  143. transtractor-0.9.0/src/parsers/transaction/utils/get_end_line_fields.rs +56 -0
  144. transtractor-0.9.0/src/parsers/transaction/utils/get_new_line_fields.rs +57 -0
  145. transtractor-0.9.0/src/parsers/transaction/utils/get_next_fields.rs +78 -0
  146. transtractor-0.9.0/src/parsers/transaction/utils/mod.rs +11 -0
  147. transtractor-0.9.0/src/python/exceptions.rs +7 -0
  148. transtractor-0.9.0/src/python/lib_config_db.rs +61 -0
  149. transtractor-0.9.0/src/python/lib_parser.rs +168 -0
  150. transtractor-0.9.0/src/python/mod.rs +4 -0
  151. transtractor-0.9.0/src/python/utils.rs +102 -0
  152. transtractor-0.9.0/src/structs/mod.rs +12 -0
  153. transtractor-0.9.0/src/structs/proto_transaction.rs +293 -0
  154. transtractor-0.9.0/src/structs/statement_config.rs +190 -0
  155. transtractor-0.9.0/src/structs/statement_data.rs +142 -0
  156. transtractor-0.9.0/src/structs/text_item.rs +127 -0
  157. transtractor-0.9.0/src/structs/text_items/buffer.rs +16 -0
  158. transtractor-0.9.0/src/structs/text_items/mod.rs +7 -0
  159. transtractor-0.9.0/src/structs/text_items/sort.rs +87 -0
  160. transtractor-0.9.0/src/structs/text_items/tokenise.rs +23 -0
  161. transtractor-0.9.0/src/structs/transaction.rs +23 -0
  162. transtractor-0.9.0/tests/fixtures/test1.pdf +0 -0
  163. transtractor-0.9.0/tests/fixtures/test1_config.json +65 -0
  164. transtractor-0.9.0/tests/fixtures/test1_config_invalid.json +65 -0
  165. transtractor-0.9.0/tests/fixtures/test1_config_misconfigured.json +65 -0
  166. transtractor-0.9.0/tests/fixtures/test1_debug.txt +75 -0
  167. transtractor-0.9.0/tests/fixtures/test1_layout.txt +92 -0
  168. transtractor-0.9.0/tests/fixtures/test1_layout_5_2.txt +92 -0
  169. transtractor-0.9.0/tests/fixtures/test1_parsed.csv +63 -0
  170. transtractor-0.9.0/tests/fixtures/test1_test.csv +2 -0
  171. transtractor-0.9.0/tests/fixtures/test1_test_NoErrorFreeStatementData.csv +2 -0
  172. transtractor-0.9.0/tests/fixtures/test1_test_StatementNotSupported.csv +2 -0
  173. transtractor-0.9.0/tests/python/test_parser__debug.py +67 -0
  174. transtractor-0.9.0/tests/python/test_parser__layout.py +74 -0
  175. transtractor-0.9.0/tests/python/test_parser__load.py +21 -0
  176. transtractor-0.9.0/tests/python/test_parser__parse.py +84 -0
  177. transtractor-0.9.0/tests/python/test_parser__test.py +179 -0
@@ -0,0 +1,179 @@
1
+ # This file is autogenerated by maturin v1.10.2
2
+ # To update, run
3
+ #
4
+ # maturin generate-ci github
5
+ #
6
+ name: CI
7
+
8
+ on:
9
+ push:
10
+ branches:
11
+ - main
12
+ - master
13
+ tags:
14
+ - '*'
15
+ pull_request:
16
+ workflow_dispatch:
17
+
18
+ permissions:
19
+ contents: read
20
+
21
+ jobs:
22
+ linux:
23
+ runs-on: ${{ matrix.platform.runner }}
24
+ strategy:
25
+ matrix:
26
+ platform:
27
+ - runner: ubuntu-22.04
28
+ target: x86_64
29
+ - runner: ubuntu-22.04
30
+ target: x86
31
+ - runner: ubuntu-22.04
32
+ target: aarch64
33
+ - runner: ubuntu-22.04
34
+ target: armv7
35
+ - runner: ubuntu-22.04
36
+ target: s390x
37
+ - runner: ubuntu-22.04
38
+ target: ppc64le
39
+ steps:
40
+ - uses: actions/checkout@v4
41
+ - uses: actions/setup-python@v5
42
+ with:
43
+ python-version: 3.x
44
+ - name: Build wheels
45
+ uses: PyO3/maturin-action@v1
46
+ with:
47
+ target: ${{ matrix.platform.target }}
48
+ args: --release --out dist --find-interpreter
49
+ sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
50
+ manylinux: auto
51
+ - name: Upload wheels
52
+ uses: actions/upload-artifact@v4
53
+ with:
54
+ name: wheels-linux-${{ matrix.platform.target }}
55
+ path: dist
56
+
57
+ musllinux:
58
+ runs-on: ${{ matrix.platform.runner }}
59
+ strategy:
60
+ matrix:
61
+ platform:
62
+ - runner: ubuntu-22.04
63
+ target: x86_64
64
+ - runner: ubuntu-22.04
65
+ target: x86
66
+ - runner: ubuntu-22.04
67
+ target: aarch64
68
+ - runner: ubuntu-22.04
69
+ target: armv7
70
+ steps:
71
+ - uses: actions/checkout@v4
72
+ - uses: actions/setup-python@v5
73
+ with:
74
+ python-version: 3.x
75
+ - name: Build wheels
76
+ uses: PyO3/maturin-action@v1
77
+ with:
78
+ target: ${{ matrix.platform.target }}
79
+ args: --release --out dist --find-interpreter
80
+ sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
81
+ manylinux: musllinux_1_2
82
+ - name: Upload wheels
83
+ uses: actions/upload-artifact@v4
84
+ with:
85
+ name: wheels-musllinux-${{ matrix.platform.target }}
86
+ path: dist
87
+
88
+ windows:
89
+ runs-on: ${{ matrix.platform.runner }}
90
+ strategy:
91
+ matrix:
92
+ platform:
93
+ - runner: windows-latest
94
+ target: x64
95
+ - runner: windows-latest
96
+ target: x86
97
+ steps:
98
+ - uses: actions/checkout@v4
99
+ - uses: actions/setup-python@v5
100
+ with:
101
+ python-version: 3.x
102
+ architecture: ${{ matrix.platform.target }}
103
+ - name: Build wheels
104
+ uses: PyO3/maturin-action@v1
105
+ with:
106
+ target: ${{ matrix.platform.target }}
107
+ args: --release --out dist --find-interpreter
108
+ sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
109
+ - name: Upload wheels
110
+ uses: actions/upload-artifact@v4
111
+ with:
112
+ name: wheels-windows-${{ matrix.platform.target }}
113
+ path: dist
114
+
115
+ macos:
116
+ runs-on: ${{ matrix.platform.runner }}
117
+ strategy:
118
+ matrix:
119
+ platform:
120
+ - runner: macos-14
121
+ target: aarch64
122
+ steps:
123
+ - uses: actions/checkout@v4
124
+ - uses: actions/setup-python@v5
125
+ with:
126
+ python-version: 3.x
127
+ - name: Build wheels
128
+ uses: PyO3/maturin-action@v1
129
+ with:
130
+ target: ${{ matrix.platform.target }}
131
+ args: --release --out dist --find-interpreter
132
+ sccache: ${{ !startsWith(github.ref, 'refs/tags/') }}
133
+ - name: Upload wheels
134
+ uses: actions/upload-artifact@v4
135
+ with:
136
+ name: wheels-macos-${{ matrix.platform.target }}
137
+ path: dist
138
+
139
+ sdist:
140
+ runs-on: ubuntu-latest
141
+ steps:
142
+ - uses: actions/checkout@v4
143
+ - name: Build sdist
144
+ uses: PyO3/maturin-action@v1
145
+ with:
146
+ command: sdist
147
+ args: --out dist
148
+ - name: Upload sdist
149
+ uses: actions/upload-artifact@v4
150
+ with:
151
+ name: wheels-sdist
152
+ path: dist
153
+
154
+ release:
155
+ name: Release
156
+ runs-on: ubuntu-latest
157
+ if: ${{ startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' }}
158
+ needs: [linux, musllinux, windows, macos, sdist]
159
+ permissions:
160
+ # Use to sign the release artifacts
161
+ id-token: write
162
+ # Used to upload release artifacts
163
+ contents: write
164
+ # Used to generate artifact attestation
165
+ attestations: write
166
+ steps:
167
+ - uses: actions/download-artifact@v4
168
+ - name: Generate artifact attestation
169
+ uses: actions/attest-build-provenance@v2
170
+ with:
171
+ subject-path: 'wheels-*/*'
172
+ - name: Publish to PyPI
173
+ if: ${{ startsWith(github.ref, 'refs/tags/') }}
174
+ uses: PyO3/maturin-action@v1
175
+ env:
176
+ MATURIN_PYPI_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
177
+ with:
178
+ command: upload
179
+ args: --non-interactive --skip-existing wheels-*/*
@@ -0,0 +1,58 @@
1
+ name: Tests
2
+
3
+ on:
4
+ push:
5
+ branches: [ "main" ]
6
+ pull_request:
7
+ branches: [ "main" ]
8
+
9
+ env:
10
+ CARGO_TERM_COLOR: always
11
+
12
+ jobs:
13
+ build:
14
+
15
+ runs-on: ubuntu-latest
16
+
17
+ strategy:
18
+ matrix:
19
+ python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
20
+
21
+ steps:
22
+ - uses: actions/checkout@v4
23
+
24
+ - name: Set up Python ${{ matrix.python-version }}
25
+ uses: actions/setup-python@v5
26
+ with:
27
+ python-version: ${{ matrix.python-version }}
28
+
29
+ - name: Build Rust
30
+ run: cargo build --verbose
31
+
32
+ - name: Run Rust tests
33
+ run: cargo test --verbose
34
+
35
+ - name: Create virtual environment
36
+ run: python -m venv .venv
37
+
38
+ - name: Install Python dependencies
39
+ run: |
40
+ source .venv/bin/activate
41
+ python -m pip install --upgrade pip
42
+ pip install maturin pylint pytest pytest-cov
43
+
44
+ - name: Build Python package
45
+ run: |
46
+ source .venv/bin/activate
47
+ maturin develop --release
48
+
49
+ - name: Run pylint
50
+ run: |
51
+ source .venv/bin/activate
52
+ pylint python/transtractor --fail-under=10.0 --recursive=y
53
+ pylint tests/python --fail-under=10.0 --recursive=y
54
+
55
+ - name: Run pytest with coverage
56
+ run: |
57
+ source .venv/bin/activate
58
+ pytest tests/python/ --cov=transtractor --cov-report=term-missing
@@ -0,0 +1,210 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ #Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ #uv.lock
102
+
103
+ # poetry
104
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
106
+ # commonly ignored for libraries.
107
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108
+ #poetry.lock
109
+ #poetry.toml
110
+
111
+ # pdm
112
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115
+ #pdm.lock
116
+ #pdm.toml
117
+ .pdm-python
118
+ .pdm-build/
119
+
120
+ # pixi
121
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122
+ #pixi.lock
123
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124
+ # in the .venv directory. It is recommended not to include this directory in version control.
125
+ .pixi
126
+
127
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128
+ __pypackages__/
129
+
130
+ # Celery stuff
131
+ celerybeat-schedule
132
+ celerybeat.pid
133
+
134
+ # SageMath parsed files
135
+ *.sage.py
136
+
137
+ # Environments
138
+ .env
139
+ .envrc
140
+ .venv
141
+ env/
142
+ venv/
143
+ ENV/
144
+ env.bak/
145
+ venv.bak/
146
+
147
+ # Spyder project settings
148
+ .spyderproject
149
+ .spyproject
150
+
151
+ # Rope project settings
152
+ .ropeproject
153
+
154
+ # mkdocs documentation
155
+ /site
156
+
157
+ # mypy
158
+ .mypy_cache/
159
+ .dmypy.json
160
+ dmypy.json
161
+
162
+ # Pyre type checker
163
+ .pyre/
164
+
165
+ # pytype static type analyzer
166
+ .pytype/
167
+
168
+ # Cython debug symbols
169
+ cython_debug/
170
+
171
+ # PyCharm
172
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
173
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
175
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
176
+ #.idea/
177
+
178
+ # Abstra
179
+ # Abstra is an AI-powered process automation framework.
180
+ # Ignore directories containing user credentials, local state, and settings.
181
+ # Learn more at https://abstra.io/docs
182
+ .abstra/
183
+
184
+ # Visual Studio Code
185
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
186
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
187
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
188
+ # you could uncomment the following to ignore the entire vscode folder
189
+ # .vscode/
190
+
191
+ # Ruff stuff:
192
+ .ruff_cache/
193
+
194
+ # PyPI configuration file
195
+ .pypirc
196
+
197
+ # Cursor
198
+ # Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
199
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
200
+ # refer to https://docs.cursor.com/context/ignore-files
201
+ .cursorignore
202
+ .cursorindexingignore
203
+
204
+ # Marimo
205
+ marimo/_static/
206
+ marimo/_lsp/
207
+ __marimo__/
208
+
209
+ # Custom
210
+ pdf/
@@ -0,0 +1,22 @@
1
+ # Read the Docs configuration file
2
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3
+
4
+ # Required
5
+ version: 2
6
+
7
+ # Set the OS, Python version, and other tools you might need
8
+ build:
9
+ os: ubuntu-24.04
10
+ tools:
11
+ python: "3.13"
12
+
13
+ # Build documentation in the "docs/" directory with Sphinx
14
+ sphinx:
15
+ configuration: docs/conf.py
16
+
17
+ # Optionally, but recommended,
18
+ # declare the Python requirements required to build your documentation
19
+ # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
20
+ python:
21
+ install:
22
+ - requirements: docs/requirements.txt