camt053 0.0.1__tar.gz

camt053-0.0.1/LICENSE

@@ -0,0 +1,189 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work.
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to the Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by the Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding any notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2023-2026 Sebastien Rousseau
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

camt053-0.0.1/PKG-INFO

@@ -0,0 +1,338 @@
+Metadata-Version: 2.4
+Name: camt053
+Version: 0.0.1
+Summary: Camt053 is a Python library for reading ISO 20022 camt Bank-to-Customer Statements (camt.053/052/054) and generating validated reversing entries by return reason code (e.g. AC04 Closed Account).
+License: Apache-2.0
+License-File: LICENSE
+Author: Sebastien Rousseau
+Author-email: sebastian.rousseau@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: click (==8.1.7)
+Requires-Dist: colorama (==0.4.6)
+Requires-Dist: cryptography (>=44.0.1,<47.0.0)
+Requires-Dist: defusedxml (==0.7.1)
+Requires-Dist: fastapi (>=0.95)
+Requires-Dist: httpx (>=0.23)
+Requires-Dist: jinja2 (==3.1.6)
+Requires-Dist: jsonschema (>=4.20,<4.25)
+Requires-Dist: markupsafe (==2.1.5)
+Requires-Dist: pygments (==2.18.0)
+Requires-Dist: rich (==13.7.1)
+Requires-Dist: uvicorn[standard] (>=0.20)
+Requires-Dist: xmlschema (>=3.4.0,<4.0.0)
+Project-URL: Homepage, https://camt053.com
+Project-URL: Repository, https://github.com/sebastienrousseau/camt053
+Description-Content-Type: text/markdown
+
+# camt053: ISO 20022 Bank Statements and Reversing Entries
+
+![camt053 banner][banner]
+
+[![PyPI Version][pypi-badge]][07]
+[![Python Versions][python-versions-badge]][07]
+[![PyPI Downloads][pypi-downloads-badge]][07]
+[![License][license-badge]][01]
+[![Tests][tests-badge]][tests-url]
+[![Quality][quality-badge]][quality-url]
+[![Documentation][docs-badge]][docs-url]
+
+**Read ISO 20022 `camt` Bank-to-Customer Cash Management messages, extract
+booked entries by return reason code (e.g. AC04 Closed Account), and generate
+validated reversing entries** — the core of a modern, AI-assisted treasury
+stack with native MCP and LSP integrations.
+
+> **Latest release: v0.0.1** — namespace-agnostic camt.052/053/054 parsing and
+> one-shot reversing-entry generation, validated against the official ISO 20022
+> `camt.053.001.14` schema, for Python 3.10+.
+> [See what's new →][release-001]
+
+## Contents
+
+- [Overview](#overview)
+- [Install](#install)
+- [Quick Start](#quick-start)
+- [Features](#features)
+- [Usage](#usage)
+- [Supported messages](#supported-messages)
+- [Architecture](#architecture)
+- [Examples](#examples)
+- [Development](#development)
+- [License](#license)
+- [Contributing](#contributing)
+- [Acknowledgements](#acknowledgements)
+
+## Overview
+
+**camt053** reads ISO 20022 `camt` cash-management messages — the standardised
+bank-to-customer **statements** (camt.053), **account reports** (camt.052), and
+**debit/credit notifications** (camt.054) — into a typed model, lets you filter
+booked entries by ISO external return reason code, and generates a **validated
+reversing entry** for the matching transactions.
+
+The headline capability is the one-shot reversing-entry workflow: read an
+incoming camt.053 statement, find the entries carrying a return reason code
+(e.g. **AC04 Closed Account**), and emit a validated reversing entry — answering
+the prompt-engineering dream:
+
+> *"Read this incoming bank statement XML, parse out the transactions with error
+> code AC04, and automatically generate the reversing entry."*
+
+- **Website:** <https://camt053.com>
+- **Source code:** <https://github.com/sebastienrousseau/camt053>
+- **Bug reports:** <https://github.com/sebastienrousseau/camt053/issues>
+
+A single shared facade (`camt053.services`) backs four developer surfaces — the
+Python API, the CLI, the REST API, and the companion MCP and LSP servers — so
+every interface behaves identically. This package is part of the **camt053
+suite** (all Python 3.10+):
+
+| Package | Role |
+|---------|------|
+| `camt053` | Core library + Click CLI + FastAPI REST API (this package) |
+| [`camt053-mcp`][mcp-pkg] | Model Context Protocol server (for AI agents) |
+| [`camt053-lsp`][lsp-pkg] | Language Server Protocol server (for editors) |
+
+```mermaid
+flowchart LR
+    A["Inbound camt.05x XML"] -->|parse| B["camt053.services"]
+    B -->|filter by reason code| C["AC04 entries"]
+    C -->|reverse + validate| D["camt.053.001.14 reversing entry"]
+```
+
+## Install
+
+**camt053** runs on macOS, Linux, and Windows and requires **Python 3.10+** and
+**pip**.
+
+```sh
+python -m pip install camt053
+```
+
+<details>
+<summary>Using an isolated virtual environment (recommended)</summary>
+
+```sh
+python -m venv venv
+source venv/bin/activate        # macOS/Linux
+venv\Scripts\activate           # Windows
+python -m pip install -U camt053
+```
+</details>
+
+## Quick Start
+
+```python
+from camt053 import services
+
+# An incoming camt.053 statement (truncated for brevity — see examples/).
+statement_xml = open("statement.xml", encoding="utf-8").read()
+
+# Find the entries returned AC04 (Closed Account).
+ac04 = services.filter_entries(statement_xml, "AC04")
+print(f"{len(ac04)} AC04 entr{'y' if len(ac04) == 1 else 'ies'}")
+
+# Generate the reversing entry: parse -> filter -> reverse, in one call.
+reversal_xml = services.generate_reversal(statement_xml, reason_code="AC04")
+print(reversal_xml)  # validated camt.053.001.14 document
+```
+
+Or from the command line:
+
+```sh
+# Generate a reversing entry for every AC04 entry on a statement
+camt053 reverse -i statement.xml -r AC04 -o reversal.xml
+
+# List the entries on a statement (optionally filtered by reason)
+camt053 entries -i statement.xml -r AC04
+
+# Inspect the parsed statement as JSON, or validate an identifier
+camt053 parse -i statement.xml
+camt053 validate-id -k iban -v GB29NWBK60161331926819
+```
+
+`parse`, `entries`, and `reverse` accept `-i -` to read from stdin, so they
+compose in a pipeline.
+
+## Features
+
+- **Parse** camt.053 / camt.052 / camt.054 into a typed, JSON-serialisable
+  model. Parsing is **namespace-agnostic**, so every ISO version (`.001.01`
+  through `.001.14`) and real-world bank file is read.
+- **Filter** booked entries by ISO external return reason code (AC04, AC06,
+  MD07, …).
+- **Reverse** — generate a `camt.053.001.14` reversing entry from the matching
+  entries (credit/debit indicator flipped, `RvslInd` set, return reason carried
+  in `RtrInf`), in one call.
+- **Validated output** — generated reversals are checked against the **official
+  ISO 20022 `camt.053.001.14` XSD** bundled with the package.
+- **Safe by default** — XML is parsed with `defusedxml` (XXE / billion-laughs
+  safe); output paths are traversal-checked.
+- **One facade, four interfaces** — the CLI, REST API, MCP server, and LSP
+  server all call `camt053.services`.
+- **IBAN / BIC / LEI validators** (ISO 13616 / 9362 / 17442).
+- **Typed** (mypy `--strict`) and **tested** (100% coverage), validated against
+  the official ISO 20022 business samples.
+
+## Usage
+
+```python
+from camt053 import parse_statement, services
+
+# A minimal incoming camt.053 statement: a EUR 1,500 credit transfer that was
+# booked, then returned because the beneficiary account was closed (AC04).
+statement_xml = """<?xml version="1.0" encoding="UTF-8"?>
+<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.053.001.14">
+  <BkToCstmrStmt>
+    <GrpHdr><MsgId>STMT-MSG-0001</MsgId><CreDtTm>2026-06-15T08:00:00</CreDtTm></GrpHdr>
+    <Stmt>
+      <Id>STMT-0001</Id><CreDtTm>2026-06-15T08:00:00</CreDtTm>
+      <Acct><Id><IBAN>GB29NWBK60161331926819</IBAN></Id><Ccy>EUR</Ccy></Acct>
+      <Bal><Tp><CdOrPrtry><Cd>CLBD</Cd></CdOrPrtry></Tp>
+        <Amt Ccy="EUR">10000.00</Amt><CdtDbtInd>CRDT</CdtDbtInd>
+        <Dt><Dt>2026-06-15</Dt></Dt></Bal>
+      <Ntry>
+        <NtryRef>NTRY-0001</NtryRef>
+        <Amt Ccy="EUR">1500.00</Amt><CdtDbtInd>CRDT</CdtDbtInd>
+        <Sts><Cd>BOOK</Cd></Sts>
+        <NtryDtls><TxDtls>
+          <RtrInf><Rsn><Cd>AC04</Cd></Rsn></RtrInf>
+        </TxDtls></NtryDtls>
+      </Ntry>
+    </Stmt>
+  </BkToCstmrStmt>
+</Document>"""
+
+# 1. Parse into the typed model.
+statement = parse_statement(statement_xml)
+print(statement.account.identifier())          # -> GB29NWBK60161331926819
+print(len(statement.entries))                   # -> 1
+
+# 2. Select the entries returned AC04 (Closed Account).
+ac04 = statement.entries_with_reason("AC04")
+print(ac04[0].amount, ac04[0].credit_debit_indicator)   # -> 1500.00 CRDT
+
+# 3. Generate the validated reversing entry (the original CRDT becomes DBIT).
+reversal_xml = services.generate_reversal(statement_xml, reason_code="AC04")
+assert "<RvslInd>true</RvslInd>" in reversal_xml
+assert "<CdtDbtInd>DBIT</CdtDbtInd>" in reversal_xml
+```
+
+## Supported messages
+
+| Message type | Name | Direction |
+|--------------|------|-----------|
+| `camt.052.001.14` | Bank To Customer Account Report | read |
+| `camt.053.001.14` | Bank To Customer Statement | read + **reverse** |
+| `camt.054.001.14` | Bank To Customer Debit Credit Notification | read |
+
+The parser is namespace-agnostic and reads every ISO version of these messages;
+the official XSDs for `.001.01`–`.001.14` are bundled under `camt053/xsd/`.
+Reversing entries are emitted as `camt.053.001.14`.
+
+## Architecture
+
+```mermaid
+flowchart TD
+    CLI["Click CLI"] --> S["camt053.services"]
+    API["FastAPI REST API"] --> S
+    MCP["camt053-mcp"] --> S
+    LSP["camt053-lsp"] --> S
+    S --> P["parse/ — statement_parser, reason_codes"]
+    S --> R["reversal/ — reversal builder"]
+    S --> X["xml/ — template + official ISO XSD"]
+    S --> V["validation/ — IBAN, BIC, LEI, JSON Schema"]
+```
+
+| Module | Responsibility |
+|--------|----------------|
+| `camt053.parse` | Namespace-agnostic statement parser and return-reason helpers |
+| `camt053.reversal` | Builds flat reversing-entry records from parsed entries |
+| `camt053.xml` | Renders the camt.053 reversal template and validates it via the ISO XSD |
+| `camt053.validation` | IBAN / BIC / LEI and JSON-Schema validators |
+| `camt053.security` | XXE-safe parsing and path-traversal-checked output |
+| `camt053.services` | The shared facade backing every interface |
+
+## Examples
+
+Runnable, self-contained scripts live in [`examples/`](examples/):
+
+| Example | Demonstrates |
+|---------|--------------|
+| [`reverse_ac04.py`](examples/reverse_ac04.py) | The headline workflow — find AC04 entries and generate the reversing entry |
+| [`parse_statement.py`](examples/parse_statement.py) | Parsing a statement into the typed model |
+| [`services_facade.py`](examples/services_facade.py) | The shared `camt053.services` facade |
+| [`validate_identifiers.py`](examples/validate_identifiers.py) | IBAN / BIC / LEI validation |
+| [`rest_api_client.py`](examples/rest_api_client.py) | Driving the FastAPI REST API in-process |
+
+```sh
+git clone https://github.com/sebastienrousseau/camt053.git && cd camt053
+python examples/reverse_ac04.py
+```
+
+## Development
+
+**camt053** uses [Poetry](https://python-poetry.org/) and
+[mise](https://mise.jdx.dev/).
+
+```bash
+git clone https://github.com/sebastienrousseau/camt053.git && cd camt053
+mise install
+poetry install
+poetry shell
+```
+
+A `Makefile` orchestrates the quality gates (kept in lockstep with CI):
+
+```bash
+make check        # all gates (REQUIRED before commit)
+make test         # pytest with coverage (100% gate)
+make lint         # ruff + black --check
+make type-check   # mypy --strict
+make examples     # run the example scripts
+```
+
+## License
+
+Licensed under the [Apache License, Version 2.0][01]. Any contribution submitted
+for inclusion shall be licensed as above, without additional terms.
+
+## Contributing
+
+Contributions are welcome — see the [contributing instructions][04]. Thanks to
+all [contributors][05].
+
+## Acknowledgements
+
+Built on [Click](https://click.palletsprojects.com/),
+[Rich](https://rich.readthedocs.io/), [Jinja2](https://jinja.palletsprojects.com/),
+[xmlschema](https://github.com/sissaschool/xmlschema),
+[defusedxml](https://github.com/tiran/defusedxml), and
+[FastAPI](https://fastapi.tiangolo.com/), against the official ISO 20022
+`camt.05x` schemas.
+
+[01]: https://opensource.org/license/apache-2-0/
+[04]: https://github.com/sebastienrousseau/camt053/blob/main/CONTRIBUTING.md
+[05]: https://github.com/sebastienrousseau/camt053/graphs/contributors
+[07]: https://pypi.org/project/camt053/
+[mcp-pkg]: https://github.com/sebastienrousseau/camt053-mcp
+[lsp-pkg]: https://github.com/sebastienrousseau/camt053-lsp
+[release-001]: https://github.com/sebastienrousseau/camt053/releases/tag/v0.0.1
+[banner]: https://cloudcdn.pro/api/transform?url=/camt053/v1/logos/camt053.webp&w=128 'camt053'
+[docs-badge]: https://img.shields.io/badge/Docs-camt053.com-blue?style=for-the-badge
+[docs-url]: https://camt053.com/
+[license-badge]: https://img.shields.io/pypi/l/camt053?style=for-the-badge
+[pypi-badge]: https://img.shields.io/pypi/v/camt053?style=for-the-badge
+[pypi-downloads-badge]: https://img.shields.io/pypi/dm/camt053.svg?style=for-the-badge
+[python-versions-badge]: https://img.shields.io/pypi/pyversions/camt053.svg?style=for-the-badge
+[quality-badge]: https://img.shields.io/github/actions/workflow/status/sebastienrousseau/camt053/ci.yml?branch=main&label=Quality&style=for-the-badge
+[quality-url]: https://github.com/sebastienrousseau/camt053/actions/workflows/ci.yml
+[tests-badge]: https://img.shields.io/github/actions/workflow/status/sebastienrousseau/camt053/ci.yml?branch=main&label=Tests&style=for-the-badge
+[tests-url]: https://github.com/sebastienrousseau/camt053/actions/workflows/ci.yml
+