sdc-gdr2edifact 4.0.0__tar.gz

sdc_gdr2edifact-4.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+      (an example is provided in the Appendix below).
+
+      "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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

sdc_gdr2edifact-4.0.0/NOTICE

@@ -0,0 +1,14 @@
+Copyright 2026 Axius SDC, Inc.
+
+Licensed under the Apache License, Version 2.0.
+
+The UN/EDIFACT directory is not part of this package or this repository. The package reads the archive each user
+downloads from UNECE (https://unece.org/trade/uncefact/unedifact/download), unmodified; the directory is © United
+Nations and licensed by the UN on the terms of the license agreement inside the archive (LICENAGR.TXT).
+
+The test fixtures under samples/ are the published packages of the eight models of the business documents library and
+293 records generated by HalvorsenDemo (https://github.com/SemanticDataCharter/HalvorsenDemo, Apache 2.0);
+tests/golden/ holds five DESADV interchanges written from those records by the UN-EDIFACT library's DESADV writer. The
+companies and documents are fictitious.
+
+The tests use pydifact (https://github.com/nerdocs/pydifact, MIT) as an independent parser.

sdc_gdr2edifact-4.0.0/PKG-INFO

@@ -0,0 +1,153 @@
+Metadata-Version: 2.4
+Name: sdc-gdr2edifact
+Version: 4.0.0
+Summary: Governed Data Records as conformant UN/EDIFACT D.24A interchanges, through sdc-mapper: one mapping file per model, every value reported.
+Author: Axius SDC, Inc.
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/SemanticDataCharter/sdc-gdr2edifact
+Keywords: sdc,semantic data charter,governed data record,edifact,un/edifact,unece,mapping
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: sdc-mapper<5,>=4.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pyyaml>=6.0; extra == "dev"
+Requires-Dist: lxml>=5.0; extra == "dev"
+Requires-Dist: pydifact>=0.2; extra == "dev"
+Dynamic: license-file
+
+# sdc-gdr2edifact
+
+Governed Data Records as UN/EDIFACT D.24A interchanges. A target mapper for
+[sdc-mapper](https://github.com/SemanticDataCharter/sdc-mapper): the core validates the record, resolves every value
+against its model and reports each one; this package says where each value goes in a message and writes the
+interchange, UNA to UNZ. Outbound only. Apache 2.0.
+
+**Status:** 4.0.0 in development. Every document of the business documents library has a mapping:
+
+| Model | ct_id | Message | Rules |
+|---|---|---|---|
+| Order | `h8bttbt9afwzf9zs4jhae566` | ORDERS | 213 |
+| Torvale Order (profile) | `cq1fjrvyn0fxl1kyk9y3kr1w` | ORDERS | 216 |
+| Order Response | `kuntv2wlkw54h7nxe0kqhvi2` | ORDRSP | 291 |
+| Despatch Advice | `cacl4njrwanj15g3p3so8t6h` | DESADV | 181 |
+| Receipt Advice | `tog0v0p1zit1xwpxysxwpf3d` | RECADV | 175 |
+| Invoice | `u19w614300a8ot4a7qnn2o1c` | INVOIC (380) | 249 |
+| Credit Note | `jkuyr38hydqaiwlq5vhp2rjr` | INVOIC (381) | 256 |
+| Remittance Advice | `fgtbf38cj0bwxppxn69etcci` | REMADV | 115 |
+
+## Use
+
+The directory is not part of this package (see the terms below). Download the D.24A archive from UNECE
+(https://unece.org/trade/uncefact/unedifact/download) and point the mapper at the zip, unchanged:
+
+```
+export SDC_EDIFACT_DIRECTORY=/path/to/d24a.zip
+sdc-map map edifact despatch-advice.xml --package DIR --mapping "$(python -c 'from sdc_gdr2edifact import mapping_path; print(mapping_path("cacl4njrwanj15g3p3so8t6h"))')"
+```
+
+```python
+from sdc_mapper import Engine, load_mapping
+from sdc_gdr2edifact import EDIFACTMapper, mapping_path
+
+mapper = EDIFACTMapper("/path/to/d24a.zip")          # or $SDC_EDIFACT_DIRECTORY
+result = Engine().map_record(xml, mapper, load_mapping(mapping_path("cacl4njrwanj15g3p3so8t6h")))
+result.files["DESADV.edi"]                           # UNA ... UNB ... UNH ... UNT ... UNZ, ISO 8859-1 (UNOC)
+result.report                                        # every value: declared, lookup or not representable, and why
+```
+
+Through sdc-mapper's MCP server the mapper is the target `edifact`.
+
+## The target and its terms
+
+**UN/EDIFACT**, the United Nations rules for electronic data interchange: the syntax is ISO 9735, and UNECE publishes
+the directory (UNTDID: data elements, composites, segments, code lists, message specifications) twice a year. This
+package writes **D.24A**, read from the archive UNECE published on 9 October 2024.
+
+The directory comes with UNECE's license agreement (`LICENAGR.TXT` in the archive). It grants use of the directory
+within the organization, in the country where it was acquired or where the organization is located; copies for use and
+backup within the organization; and distribution of copies of the original file as downloaded, with the license. It
+does not allow selling, sub-licensing, renting, leasing or assigning the directory, or modifying it and distributing
+the result, without the UN's written permission. So:
+
+- **This package carries no part of the directory.** It reads the archive the user downloaded, as downloaded, and
+  keeps its extraction as a working copy in the user's cache (`~/.cache/sdc-gdr2edifact/`), on the user's machine.
+- **This repository** does not carry the directory either: the tests read the archive from `SDC_EDIFACT_DIRECTORY`.
+- **GS1's EANCOM** (UN/EDIFACT's retail subset) is not a target until its terms are confirmed.
+
+Every interchange this package writes conforms to the D.24A message specification, or is not written.
+
+## Where values go: declared, one mapping file per model
+
+The business documents library links its components to UBL, not to UN/EDIFACT, so where a value goes in a message (the
+segment, its qualifier, the data element) is stated in a mapping file, `src/sdc_gdr2edifact/mappings/<document>-<ct_id>.yaml`,
+bound to the model's schema by its SHA-256. The qualifiers are the UN-EDIFACT library's mappings (`mapping/*.json`,
+reviewed by hand on 4 October 2026, from which the library's D.24A qualifier tokens were published).
+
+Where the model binds a value to a code list the directory uses, the value is a **lookup**: the business documents bind
+the payment means to UBL 2.3's PaymentMeansCode list, which is UNCL 4461 code for code (checked against D.24A), so
+PAI's 4461 is the model's own code. The handling unit and packaging types are bound to the UN/ECE Recommendations'
+page without a code, so their Recommendation 21 codes are declared, as the Recommendation 20 unit codes are. The
+allowance and charge reason is bound to UBL's AllowanceChargeReasonCode, which is UNCL 4465 (adjustment reasons); ALC
+identifies an allowance with a different list (5189), so the reason travels as ALC's text (C214 7160) and its code
+does not.
+
+The mapping files are written with `tools/build_mapping.py` from a spec in the model's labels (`tools/specs/`: one per
+message, composed with the rules every library document shares in `common.py`), which checks that every value the
+model can hold reaches a rule: placed, or omitted with a reason.
+
+**DESADV and the library's writer.** For all 52 Despatch Advice records, this mapping and the UN-EDIFACT library's
+hand-written DESADV writer (`edifact/desadv.py`) produce the same segments with the same data, and the library's reader
+reads the same values from both; the order of repeated segments within a group (references, dates, measurements) is
+the record's here. Five are kept in `tests/golden/`. The other five messages had paper mappings only; their
+placements are this package's first writers.
+
+## What UN/EDIFACT cannot say
+
+- **Exceptional Values.** UN/EDIFACT has no null flavors. A free text segment could hold the words, but no qualifier
+  the directory defines says "this value was asked for and refused" in a way a receiving system would act on, so an
+  Exceptional Value is **lost**, every ISO 21090 code alike, and the report says so. A mapping file cannot promise
+  otherwise. Where the directory requires the value, the segment or group cannot be written and its other values are
+  reported with the reason; where the interchange requires it (the sender's or the recipient's identification in
+  UNB), there is no interchange, and the call ends as an error that says which element.
+- **The record's provenance and audit**, the validity windows and recording times (act, vtb, vte, tr), and the
+  definitions each component is bound to.
+- Across the 293 sample records, 80.9% of the business values are placed (44,308 declared, 189 lookups) and 10,478 are
+  not representable, each with its reason. The largest: the UBL-facing identifiers (customization, profile, UUID),
+  which UNH and BGM already settle; a document reference's type and description (a reference group carries a number
+  and a date); an address's use, a party's endpoint and a contact's department; a tax scheme's own identifier and a
+  tax category's name (TAX codes them); flags with no element (partial delivery, back order, free of charge); a
+  receipt check's result (CDI states a condition by a code a partner agrees); a pallet build pattern.
+
+## How the writer works
+
+A message is written as a tree first: its root is the message type, `SG<n>` a segment group, a tag a segment, and
+`~x` after either tells apart segments of the same tag (`DTM~137`, `SG1~ON`). A segment's data are attributes named by
+the directory: `@3035`, `@C082.3039`, `@C080.3036#2` for a component's second occurrence, `@C212#2.7140` for a
+composite's second occurrence in its segment; a trailing `+` appends (a time after a date). From the directory the
+writer orders every group as the message specification does; adds a group's trigger segment when it has no mandatory
+data (an empty PCI) and numbers CPS hierarchies; removes a segment that lacks mandatory data, and a group that lacks its
+trigger, with the reason; continues a value too long for its component into the components of the same tag that
+follow (a long name across C080's 3036s, shipping marks across PCI's 7102s); infers a DTM's format (102, 203, 204); and
+writes UNA, UNB, UNH, UNS where the message has one, UNT with the segment count, and UNZ. The interchange and message
+control references are the document's number (its last 14 word characters).
+
+**The check is independent.** `sdc_gdr2edifact.check` parses the interchange from its text, by code that shares
+nothing with the writer, and checks the envelope (counts, references), the segment sequence against the message
+specification's segment table, and every segment against its definition; the tests also parse every interchange with
+[pydifact](https://github.com/nerdocs/pydifact) (MIT), which has no D.24A definitions but reads the syntax.
+
+## Tests
+
+```
+pip install -e ".[dev]"
+SDC_EDIFACT_DIRECTORY=/path/to/d24a.zip python -m pytest
+```
+
+Without `SDC_EDIFACT_DIRECTORY`, every test that needs the directory is skipped and says so.
+
+Every sample record of the eight models is mapped, checked and parsed; the DESADV is compared with the library's
+writer; Exceptional Values, refused mappings and a tampered interchange are exercised.

sdc_gdr2edifact-4.0.0/README.md

@@ -0,0 +1,132 @@
+# sdc-gdr2edifact
+
+Governed Data Records as UN/EDIFACT D.24A interchanges. A target mapper for
+[sdc-mapper](https://github.com/SemanticDataCharter/sdc-mapper): the core validates the record, resolves every value
+against its model and reports each one; this package says where each value goes in a message and writes the
+interchange, UNA to UNZ. Outbound only. Apache 2.0.
+
+**Status:** 4.0.0 in development. Every document of the business documents library has a mapping:
+
+| Model | ct_id | Message | Rules |
+|---|---|---|---|
+| Order | `h8bttbt9afwzf9zs4jhae566` | ORDERS | 213 |
+| Torvale Order (profile) | `cq1fjrvyn0fxl1kyk9y3kr1w` | ORDERS | 216 |
+| Order Response | `kuntv2wlkw54h7nxe0kqhvi2` | ORDRSP | 291 |
+| Despatch Advice | `cacl4njrwanj15g3p3so8t6h` | DESADV | 181 |
+| Receipt Advice | `tog0v0p1zit1xwpxysxwpf3d` | RECADV | 175 |
+| Invoice | `u19w614300a8ot4a7qnn2o1c` | INVOIC (380) | 249 |
+| Credit Note | `jkuyr38hydqaiwlq5vhp2rjr` | INVOIC (381) | 256 |
+| Remittance Advice | `fgtbf38cj0bwxppxn69etcci` | REMADV | 115 |
+
+## Use
+
+The directory is not part of this package (see the terms below). Download the D.24A archive from UNECE
+(https://unece.org/trade/uncefact/unedifact/download) and point the mapper at the zip, unchanged:
+
+```
+export SDC_EDIFACT_DIRECTORY=/path/to/d24a.zip
+sdc-map map edifact despatch-advice.xml --package DIR --mapping "$(python -c 'from sdc_gdr2edifact import mapping_path; print(mapping_path("cacl4njrwanj15g3p3so8t6h"))')"
+```
+
+```python
+from sdc_mapper import Engine, load_mapping
+from sdc_gdr2edifact import EDIFACTMapper, mapping_path
+
+mapper = EDIFACTMapper("/path/to/d24a.zip")          # or $SDC_EDIFACT_DIRECTORY
+result = Engine().map_record(xml, mapper, load_mapping(mapping_path("cacl4njrwanj15g3p3so8t6h")))
+result.files["DESADV.edi"]                           # UNA ... UNB ... UNH ... UNT ... UNZ, ISO 8859-1 (UNOC)
+result.report                                        # every value: declared, lookup or not representable, and why
+```
+
+Through sdc-mapper's MCP server the mapper is the target `edifact`.
+
+## The target and its terms
+
+**UN/EDIFACT**, the United Nations rules for electronic data interchange: the syntax is ISO 9735, and UNECE publishes
+the directory (UNTDID: data elements, composites, segments, code lists, message specifications) twice a year. This
+package writes **D.24A**, read from the archive UNECE published on 9 October 2024.
+
+The directory comes with UNECE's license agreement (`LICENAGR.TXT` in the archive). It grants use of the directory
+within the organization, in the country where it was acquired or where the organization is located; copies for use and
+backup within the organization; and distribution of copies of the original file as downloaded, with the license. It
+does not allow selling, sub-licensing, renting, leasing or assigning the directory, or modifying it and distributing
+the result, without the UN's written permission. So:
+
+- **This package carries no part of the directory.** It reads the archive the user downloaded, as downloaded, and
+  keeps its extraction as a working copy in the user's cache (`~/.cache/sdc-gdr2edifact/`), on the user's machine.
+- **This repository** does not carry the directory either: the tests read the archive from `SDC_EDIFACT_DIRECTORY`.
+- **GS1's EANCOM** (UN/EDIFACT's retail subset) is not a target until its terms are confirmed.
+
+Every interchange this package writes conforms to the D.24A message specification, or is not written.
+
+## Where values go: declared, one mapping file per model
+
+The business documents library links its components to UBL, not to UN/EDIFACT, so where a value goes in a message (the
+segment, its qualifier, the data element) is stated in a mapping file, `src/sdc_gdr2edifact/mappings/<document>-<ct_id>.yaml`,
+bound to the model's schema by its SHA-256. The qualifiers are the UN-EDIFACT library's mappings (`mapping/*.json`,
+reviewed by hand on 4 October 2026, from which the library's D.24A qualifier tokens were published).
+
+Where the model binds a value to a code list the directory uses, the value is a **lookup**: the business documents bind
+the payment means to UBL 2.3's PaymentMeansCode list, which is UNCL 4461 code for code (checked against D.24A), so
+PAI's 4461 is the model's own code. The handling unit and packaging types are bound to the UN/ECE Recommendations'
+page without a code, so their Recommendation 21 codes are declared, as the Recommendation 20 unit codes are. The
+allowance and charge reason is bound to UBL's AllowanceChargeReasonCode, which is UNCL 4465 (adjustment reasons); ALC
+identifies an allowance with a different list (5189), so the reason travels as ALC's text (C214 7160) and its code
+does not.
+
+The mapping files are written with `tools/build_mapping.py` from a spec in the model's labels (`tools/specs/`: one per
+message, composed with the rules every library document shares in `common.py`), which checks that every value the
+model can hold reaches a rule: placed, or omitted with a reason.
+
+**DESADV and the library's writer.** For all 52 Despatch Advice records, this mapping and the UN-EDIFACT library's
+hand-written DESADV writer (`edifact/desadv.py`) produce the same segments with the same data, and the library's reader
+reads the same values from both; the order of repeated segments within a group (references, dates, measurements) is
+the record's here. Five are kept in `tests/golden/`. The other five messages had paper mappings only; their
+placements are this package's first writers.
+
+## What UN/EDIFACT cannot say
+
+- **Exceptional Values.** UN/EDIFACT has no null flavors. A free text segment could hold the words, but no qualifier
+  the directory defines says "this value was asked for and refused" in a way a receiving system would act on, so an
+  Exceptional Value is **lost**, every ISO 21090 code alike, and the report says so. A mapping file cannot promise
+  otherwise. Where the directory requires the value, the segment or group cannot be written and its other values are
+  reported with the reason; where the interchange requires it (the sender's or the recipient's identification in
+  UNB), there is no interchange, and the call ends as an error that says which element.
+- **The record's provenance and audit**, the validity windows and recording times (act, vtb, vte, tr), and the
+  definitions each component is bound to.
+- Across the 293 sample records, 80.9% of the business values are placed (44,308 declared, 189 lookups) and 10,478 are
+  not representable, each with its reason. The largest: the UBL-facing identifiers (customization, profile, UUID),
+  which UNH and BGM already settle; a document reference's type and description (a reference group carries a number
+  and a date); an address's use, a party's endpoint and a contact's department; a tax scheme's own identifier and a
+  tax category's name (TAX codes them); flags with no element (partial delivery, back order, free of charge); a
+  receipt check's result (CDI states a condition by a code a partner agrees); a pallet build pattern.
+
+## How the writer works
+
+A message is written as a tree first: its root is the message type, `SG<n>` a segment group, a tag a segment, and
+`~x` after either tells apart segments of the same tag (`DTM~137`, `SG1~ON`). A segment's data are attributes named by
+the directory: `@3035`, `@C082.3039`, `@C080.3036#2` for a component's second occurrence, `@C212#2.7140` for a
+composite's second occurrence in its segment; a trailing `+` appends (a time after a date). From the directory the
+writer orders every group as the message specification does; adds a group's trigger segment when it has no mandatory
+data (an empty PCI) and numbers CPS hierarchies; removes a segment that lacks mandatory data, and a group that lacks its
+trigger, with the reason; continues a value too long for its component into the components of the same tag that
+follow (a long name across C080's 3036s, shipping marks across PCI's 7102s); infers a DTM's format (102, 203, 204); and
+writes UNA, UNB, UNH, UNS where the message has one, UNT with the segment count, and UNZ. The interchange and message
+control references are the document's number (its last 14 word characters).
+
+**The check is independent.** `sdc_gdr2edifact.check` parses the interchange from its text, by code that shares
+nothing with the writer, and checks the envelope (counts, references), the segment sequence against the message
+specification's segment table, and every segment against its definition; the tests also parse every interchange with
+[pydifact](https://github.com/nerdocs/pydifact) (MIT), which has no D.24A definitions but reads the syntax.
+
+## Tests
+
+```
+pip install -e ".[dev]"
+SDC_EDIFACT_DIRECTORY=/path/to/d24a.zip python -m pytest
+```
+
+Without `SDC_EDIFACT_DIRECTORY`, every test that needs the directory is skipped and says so.
+
+Every sample record of the eight models is mapped, checked and parsed; the DESADV is compared with the library's
+writer; Exceptional Values, refused mappings and a tampered interchange are exercised.

sdc_gdr2edifact-4.0.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sdc-gdr2edifact"
+version = "4.0.0"
+description = "Governed Data Records as conformant UN/EDIFACT D.24A interchanges, through sdc-mapper: one mapping file per model, every value reported."
+readme = "README.md"
+requires-python = ">=3.12"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+authors = [{ name = "Axius SDC, Inc." }]
+keywords = ["sdc", "semantic data charter", "governed data record", "edifact", "un/edifact", "unece", "mapping"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "sdc-mapper>=4.2,<5",     # placements, joins ('=name'), declared cluster order (4.2.0)
+]
+
+[project.optional-dependencies]
+dev = ["pytest>=8.0", "pyyaml>=6.0", "lxml>=5.0", "pydifact>=0.2"]
+
+[project.entry-points."sdc_mapper.targets"]
+edifact = "sdc_gdr2edifact:EDIFACTMapper"
+
+[project.urls]
+Repository = "https://github.com/SemanticDataCharter/sdc-gdr2edifact"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+sdc_gdr2edifact = ["mappings/*.yaml"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

sdc_gdr2edifact-4.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sdc_gdr2edifact-4.0.0/src/sdc_gdr2edifact/__init__.py

@@ -0,0 +1,28 @@
+"""sdc-gdr2edifact: Governed Data Records as UN/EDIFACT D.24A interchanges, through sdc-mapper.
+
+    from sdc_mapper import Engine, load_mapping
+    from sdc_gdr2edifact import EDIFACTMapper, mapping_path
+    mapper = EDIFACTMapper("/path/to/d24a.zip")       # the directory as downloaded from UNECE; or $SDC_EDIFACT_DIRECTORY
+    result = Engine().map_record(xml, mapper, load_mapping(mapping_path("cacl4njrwanj15g3p3so8t6h")))
+
+One mapping file per model, in `mappings/`. Registered with sdc-mapper as the target `edifact`.
+"""
+from pathlib import Path
+
+__version__ = "4.0.0"
+
+MAPPINGS = Path(__file__).with_name("mappings")
+
+
+def mapping_path(ct_id: str) -> Path:
+    """The mapping file this package publishes for a model, by the model's identifier."""
+    found = sorted(MAPPINGS.glob(f"*-{ct_id}.yaml"))
+    if not found:
+        raise FileNotFoundError(f"sdc-gdr2edifact has no mapping for model {ct_id}")
+    return found[-1]
+
+
+from .directory import Directory, DirectoryNotFound  # noqa: E402
+from .mapper import EDIFACTMapper  # noqa: E402
+
+__all__ = ["EDIFACTMapper", "Directory", "DirectoryNotFound", "mapping_path", "MAPPINGS", "__version__"]