cbpr-usage-rules 0.3.0__tar.gz → 0.5.0__tar.gz

{cbpr_usage_rules-0.3.0 → cbpr_usage_rules-0.5.0}/CHANGELOG.md

@@ -4,6 +4,26 @@ All notable changes to this project are documented here. The format is based on
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0]
+
+### Added
+- Deterministic **ID generation** library (`cbpr_rules.idgen`, "Counting Strings"
+  algorithm — no `random`/`uuid`): `generate_iban`, `generate_lei`, `generate_bic`,
+  `generate_uuid`/`generate_uetr`, `generate_mid`, plus `counting_string`/
+  `counting_sequence` and seeded helpers. Every id is structurally valid and passes
+  the package's own validators; same seed → same output. New CLI
+  `cbpr-validate --generate {iban,lei,bic,uuid,uetr,mid,text}` (with
+  `--seed/--country/--bank/--branch/--count`). The bundled example messages now
+  source their identifiers from this library (seeded per example).
+
+## [0.4.0]
+
+### Added
+- List only the **enforceable** rules for a year + message type:
+  `list_rules(year, msgtype, enforced_only=True)` in the API and
+  `cbpr-validate --enforced --year … --type …` on the CLI (advisory rules omitted;
+  composes with `--json`).
+
 ## [0.3.0]
 
 ### Added

{cbpr_usage_rules-0.3.0/src/cbpr_usage_rules.egg-info → cbpr_usage_rules-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cbpr-usage-rules
-Version: 0.3.0
+Version: 0.5.0
 Summary: Validate ISO 20022 CBPR+ XML messages against SWIFT usage (business) rules.
 Author: Pete Houghton
 License: MIT License
@@ -172,11 +172,34 @@ xml = cbpr_rules.example_message(2025, "pacs.008", "max")   # variant defaults t
 cbpr_rules.example_variants(2025, "pacs.008")               # ['min', 'max']
 ```
 
-The data is **fictitious** (synthetic BICs/IBANs/LEIs, `EXAMPLE` names) and does
+The data is **fictitious** (synthetic, generated BICs/IBANs/LEIs) and does
 not reproduce any real sample — use them as starting templates, not real payments.
 
 ---
 
+## Generating identifiers
+
+The example values above are produced by a small **deterministic** ID generator
+(the "Counting Strings" algorithm — no `random`/`uuid`, same seed → same output).
+Every generated id is structurally valid and passes the tool's own validators.
+
+```bash
+cbpr-validate --generate iban --country AT --seed s1     # ISO 13616 + mod-97
+cbpr-validate --generate lei  --seed acme                # ISO 17442 + check digits
+cbpr-validate --generate bic  --bank JSBP --country GB   # -> JSBPGB..XXX
+cbpr-validate --generate uuid --count 3                  # RFC 4122 v4 (UETR)
+cbpr-validate --generate mid  --country GB               # message identifier
+```
+```python
+from cbpr_rules import generate_iban, generate_lei, generate_bic, generate_uetr
+generate_iban("DE", seed="acme")   # deterministic, valid German IBAN
+generate_bic(country="GB", seed="acme")
+```
+
+IBAN generation supports the 27 EU countries plus GB.
+
+---
+
 ## The result object
 
 Both `validate_file` and `validate_string` return a dictionary:
@@ -258,11 +281,13 @@ matching is by local name, so namespace prefixes never matter.
 ```python
 cbpr_rules.available(2025)              # -> ['camt.052', 'pacs.008', ...]
 cbpr_rules.list_rules(2025, "pacs.008") # -> [{rule_number, name, description, severity, enforced}, ...]
+cbpr_rules.list_rules(2025, "pacs.008", enforced_only=True)  # only the enforceable rules
 ```
 
 ```bash
 cbpr-validate --year 2025 --list-types
-cbpr-validate --year 2025 --type pacs.008 --list
+cbpr-validate --year 2025 --type pacs.008 --list               # all rules
+cbpr-validate --year 2025 --type pacs.008 --enforced           # enforceable rules only
 ```
 
 ### Algorithmic field validation

{cbpr_usage_rules-0.3.0 → cbpr_usage_rules-0.5.0}/README.md

@@ -117,11 +117,34 @@ xml = cbpr_rules.example_message(2025, "pacs.008", "max")   # variant defaults t
 cbpr_rules.example_variants(2025, "pacs.008")               # ['min', 'max']
 ```
 
-The data is **fictitious** (synthetic BICs/IBANs/LEIs, `EXAMPLE` names) and does
+The data is **fictitious** (synthetic, generated BICs/IBANs/LEIs) and does
 not reproduce any real sample — use them as starting templates, not real payments.
 
 ---
 
+## Generating identifiers
+
+The example values above are produced by a small **deterministic** ID generator
+(the "Counting Strings" algorithm — no `random`/`uuid`, same seed → same output).
+Every generated id is structurally valid and passes the tool's own validators.
+
+```bash
+cbpr-validate --generate iban --country AT --seed s1     # ISO 13616 + mod-97
+cbpr-validate --generate lei  --seed acme                # ISO 17442 + check digits
+cbpr-validate --generate bic  --bank JSBP --country GB   # -> JSBPGB..XXX
+cbpr-validate --generate uuid --count 3                  # RFC 4122 v4 (UETR)
+cbpr-validate --generate mid  --country GB               # message identifier
+```
+```python
+from cbpr_rules import generate_iban, generate_lei, generate_bic, generate_uetr
+generate_iban("DE", seed="acme")   # deterministic, valid German IBAN
+generate_bic(country="GB", seed="acme")
+```
+
+IBAN generation supports the 27 EU countries plus GB.
+
+---
+
 ## The result object
 
 Both `validate_file` and `validate_string` return a dictionary:
@@ -203,11 +226,13 @@ matching is by local name, so namespace prefixes never matter.
 ```python
 cbpr_rules.available(2025)              # -> ['camt.052', 'pacs.008', ...]
 cbpr_rules.list_rules(2025, "pacs.008") # -> [{rule_number, name, description, severity, enforced}, ...]
+cbpr_rules.list_rules(2025, "pacs.008", enforced_only=True)  # only the enforceable rules
 ```
 
 ```bash
 cbpr-validate --year 2025 --list-types
-cbpr-validate --year 2025 --type pacs.008 --list
+cbpr-validate --year 2025 --type pacs.008 --list               # all rules
+cbpr-validate --year 2025 --type pacs.008 --enforced           # enforceable rules only
 ```
 
 ### Algorithmic field validation

{cbpr_usage_rules-0.3.0 → cbpr_usage_rules-0.5.0}/src/cbpr_rules/__init__.py

@@ -4,7 +4,7 @@ This package is AI generated. See the README for details and caveats.
 """
 from __future__ import annotations
 
-__version__ = "0.3.0"
+__version__ = "0.5.0"
 
 from .models import Rule, Severity, Violation
 from .engine import (
@@ -15,6 +15,16 @@ from .engine import (
     example_message,
     example_variants,
 )
+from .idgen import (
+    generate_iban,
+    generate_lei,
+    generate_bic,
+    generate_uuid,
+    generate_uetr,
+    generate_mid,
+    counting_string,
+    counting_sequence,
+)
 
 __all__ = [
     "__version__",
@@ -27,4 +37,12 @@ __all__ = [
     "available",
     "example_message",
     "example_variants",
+    "generate_iban",
+    "generate_lei",
+    "generate_bic",
+    "generate_uuid",
+    "generate_uetr",
+    "generate_mid",
+    "counting_string",
+    "counting_sequence",
 ]

{cbpr_usage_rules-0.3.0 → cbpr_usage_rules-0.5.0}/src/cbpr_rules/cli.py

@@ -9,6 +9,7 @@ import textwrap
 from typing import List, Optional
 
 from . import __version__
+from . import idgen
 from .engine import (
     ValidationError,
     available,
@@ -19,6 +20,29 @@ from .engine import (
 )
 
 
+def _generate(args) -> List[str]:
+    """Produce the ``--generate`` output lines (one id per --count)."""
+    kind = args.generate
+    out: List[str] = []
+    for i in range(max(args.count, 1)):
+        seed = f"{args.seed}:{i}" if args.count > 1 else args.seed
+        if kind == "iban":
+            if not args.country:
+                raise ValueError("--generate iban requires --country (e.g. --country AT)")
+            out.append(idgen.generate_iban(args.country, seed))
+        elif kind == "lei":
+            out.append(idgen.generate_lei(seed))
+        elif kind == "bic":
+            out.append(idgen.generate_bic(args.bank, args.country or "GB", args.branch, seed))
+        elif kind in ("uuid", "uetr"):
+            out.append(idgen.generate_uuid(idgen.deterministic_int(seed or str(i), 0, 2**63)))
+        elif kind == "mid":
+            out.append(idgen.generate_mid("CBPR", args.country or "GB", i + 1))
+        elif kind == "text":
+            out.append(idgen.deterministic_string(seed or "text", 16))
+    return out
+
+
 def _build_parser() -> argparse.ArgumentParser:
     p = argparse.ArgumentParser(
         prog="cbpr-validate",
@@ -72,11 +96,28 @@ def _build_parser() -> argparse.ArgumentParser:
         help="Root element tag wrapping the AppHdr+Document in --example output "
         "(default: Envelope).",
     )
+    p.add_argument(
+        "--generate",
+        choices=("iban", "lei", "bic", "uuid", "uetr", "mid", "text"),
+        help="Generate a deterministic, structurally-valid identifier and print it "
+        "(use --seed/--country/--bank/--branch/--count to control output).",
+    )
+    p.add_argument("--seed", default="", help="Seed for --generate (same seed -> same output).")
+    p.add_argument("--country", help="Country code for --generate iban/bic/mid (e.g. AT, GB).")
+    p.add_argument("--bank", help="Bank code for --generate bic (4 letters, padded with X).")
+    p.add_argument("--branch", default="XXX", help="Branch code for --generate bic (default XXX).")
+    p.add_argument("--count", type=int, default=1, help="How many ids to generate (default 1).")
     p.add_argument(
         "--list",
         action="store_true",
         help="List the rules for --year/--type instead of validating.",
     )
+    p.add_argument(
+        "--enforced",
+        action="store_true",
+        help="List only the enforceable (mechanically-checked) rules for --year/--type; "
+        "advisory rules are omitted. Implies --list.",
+    )
     p.add_argument(
         "--list-types", action="store_true", help="List message types available for --year."
     )
@@ -205,6 +246,15 @@ def main(argv: Optional[List[str]] = None) -> int:
         print(json.dumps(types) if args.json else "\n".join(types))
         return 0
 
+    if args.generate:
+        try:
+            for line in _generate(args):
+                print(line)
+        except (ValueError, ValidationError) as exc:
+            print(f"error: {exc}", file=sys.stderr)
+            return 2
+        return 0
+
     if args.example:
         if args.year is None or args.msgtype is None:
             print("error: --example requires --year and --type", file=sys.stderr)
@@ -216,11 +266,11 @@ def main(argv: Optional[List[str]] = None) -> int:
             return 2
         return 0
 
-    if args.list:
+    if args.list or args.enforced:
         if args.year is None or args.msgtype is None:
             print("error: --year and --type are required for --list", file=sys.stderr)
             return 2
-        rules = list_rules(args.year, args.msgtype)
+        rules = list_rules(args.year, args.msgtype, enforced_only=args.enforced)
         if args.json:
             print(json.dumps(rules, indent=2))
         else:

{cbpr_usage_rules-0.3.0 → cbpr_usage_rules-0.5.0}/src/cbpr_rules/engine.py

@@ -95,9 +95,16 @@ def validate_string(xml: str, year: int, msgtype: Optional[str] = None, xsd=None
     return _validate_tree(tree, year, msgtype, xsd)
 
 
-def list_rules(year: int, msgtype: str) -> List[dict]:
-    """Return metadata for every rule registered for a (year, message type)."""
-    return [r.to_dict() for r in load_rules(year, msgtype)]
+def list_rules(year: int, msgtype: str, enforced_only: bool = False) -> List[dict]:
+    """Return metadata for the rules registered for a (year, message type).
+
+    With ``enforced_only=True`` only the enforceable (mechanically-checked) rules
+    are returned, omitting advisory/catalogue-only ones.
+    """
+    rules = [r.to_dict() for r in load_rules(year, msgtype)]
+    if enforced_only:
+        rules = [r for r in rules if r["enforced"]]
+    return rules
 
 
 def available(year: int) -> List[str]: