vdi2770-validate 0.1.0__tar.gz

vdi2770_validate-0.1.0/.github/dco.yml

@@ -0,0 +1,2 @@
+require:
+  members: false

vdi2770_validate-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: check
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+      - name: Lint
+        run: python -m ruff check src tests tools
+      - name: Build fixtures
+        run: python tools/make_fixtures.py
+      - name: Test
+        run: python -m pytest
+      - name: Corpus is unchanged
+        run: python tools/vendor_corpus.py --check
+      - name: Firing coverage
+        run: python tools/rule_coverage.py --check
+      - name: The sdist can run its own tests
+        run: |
+          python -m pip install build
+          python tools/check_sdist.py

vdi2770_validate-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,54 @@
+name: release
+
+# One package in this repository, so one environment. The collision that bit the
+# sibling project was two packages sharing a (repo, workflow, environment) tuple;
+# splitting further here would be ceremony, not safety.
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip build
+          python -m pip install -e ".[dev]"
+      - name: The gate must pass on the tagged tree
+        run: |
+          python -m ruff check src tests tools
+          python tools/make_fixtures.py
+          python -m pytest
+          python tools/vendor_corpus.py --check
+          python tools/rule_coverage.py --check
+          python tools/check_sdist.py
+      - name: The tag must be the version
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          pkg=$(python -c "import sys; sys.path.insert(0,'src'); import vdi2770_validate as v; print(v.__version__)")
+          test "$tag" = "$pkg" || { echo "tag $tag != package $pkg"; exit 1; }
+      - name: Build
+        run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write        # Trusted Publishing; no API token is stored anywhere
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

vdi2770_validate-0.1.0/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+## 0.1.0 — 2026-08-24
+
+First release. It reads a VDI 2770 container and tells you what is wrong with
+it, offline, with a remedy on every finding.
+
+What 0.1.0 means here: the 33 rules it has are gated — each was killed in turn to
+confirm the suite notices, 22 have a minimal violating/conforming fixture pair,
+and the rest are exercised by the reference project's own examples, which no
+structural rule is allowed to fire on. What it does *not* mean is broad coverage
+of VDI 2770. The scope is small and written down in docs/scope.md, and the
+refusals there are the honest part.
+
+- Reads VDI 2770 document and documentation containers without extracting them.
+- 32 rules across five layers — container shape, schema conformance, declared
+  files versus actual members, metadata model, and PDF claims — each with a
+  remedy sentence and each traceable to the schema VDI publishes free, to a
+  freely published table, to container mechanics, or to a stated judgement of
+  our own.
+- Document classification matched on class id and German name. The two freely
+  published sources disagree on five of twelve English names, so an English name
+  never decides a verdict here; it produces a note showing both renderings.
+- Reports what a PDF *claims* about PDF/A. Does not verify the claim, and says so
+  on every line where it matters.
+- Gates: fixture pairs, firing coverage, import layering, offline, determinism,
+  CI/local parity, the declared Python floor, licence notices, remedy text not
+  copied from the reference, no structural rule firing on an upstream example,
+  and the README sample being output the tool really produces.

vdi2770_validate-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing
+
+## The Developer Certificate of Origin
+
+Every commit carries a `Signed-off-by` line — `git commit -s`. That is a
+[certificate of origin](https://developercertificate.org/), not a transfer of
+rights; you keep the copyright in what you write.
+
+## Before you open a pull request
+
+```bash
+python -m pip install -e ".[dev]"
+make check
+```
+
+`make check` is the whole gate: lint, build the fixtures, tests, the corpus is
+unchanged, and every rule still fires. CI runs exactly those commands — a test asserts that, because
+"the same command" is not the same thing as "the same environment".
+
+## Three rules of the road
+
+Each exists because ignoring it would break something specific.
+
+1. **A new rule is a row in `rules.json` plus a function.** The row carries where
+   the requirement comes from, and a remedy sentence saying what the user should
+   *do*. A finding that only restates the problem is half a finding.
+
+2. **A new rule needs a fixture pair.** One container that violates it, one that
+   does not, differing in as little as possible — add the violating one to
+   `tools/make_fixtures.py`. A rule that has never been seen to fire has never
+   been tested, and `make check` will say so.
+
+3. **Rules may not import a parser.** `tests/test_layering.py` fails if a module
+   under `rules/` imports `zipfile` or an XML library. (Rules do import the
+   readers' reserved file names — that exemption is written into the test.)
+   Rules read the model; how the document was spelled is not their business.
+
+## Where the requirement came from matters
+
+`rules.json` gives every rule an `obligation`: `schema` (the XSD VDI publishes
+free), `table` (a freely published table), `container` (mechanics anyone can
+observe), or `ours` — and `ours` must carry a `whyOurs` sentence.
+
+**The VDI 2770 guideline text is sold by DIN Media and is not used here.** Do not
+quote or paraphrase it, even from memory, and do not copy message text from other
+implementations into a remedy — a test checks for that. See
+[docs/licensing.md](docs/licensing.md).
+
+## Reporting something without writing code
+
+An issue with a container that is judged wrongly — in either direction — is one
+of the most useful things you can send. Strip anything confidential first; a
+minimal archive that still reproduces is ideal.

vdi2770_validate-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 Wooyong Lee (dev365code)
+
+   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.

vdi2770_validate-0.1.0/MANIFEST.in

@@ -0,0 +1,11 @@
+# The sdist must be able to run its own tests, or a downstream packager building
+# from it gets a green build that never ran the gate. This is the same class of
+# error as a check that reads a path outside the repository: "the gate exists"
+# and "the gate runs" differ only in someone else's environment.
+include LICENSE NOTICE THIRD_PARTY.md CHANGELOG.md CONTRIBUTING.md SECURITY.md Makefile
+recursive-include tests *.py *.json
+recursive-include tools *.py
+recursive-include corpus *
+recursive-include docs *.md *.json
+recursive-include .github *.yml
+prune tests/fixtures

vdi2770_validate-0.1.0/Makefile

@@ -0,0 +1,34 @@
+# One entry point. CI runs exactly these targets — tests/test_ci_parity.py proves it.
+PYTHON  ?= python3
+RUFF_VERSION   := 0.16.3
+PYTEST_VERSION := 8.3.4
+XMLSCHEMA_VERSION := 4.2.0
+
+.PHONY: check lint test fixtures corpus coverage-check sdist-runs-its-own-tests clean
+
+check: lint fixtures test corpus coverage-check
+
+lint:
+	$(PYTHON) -m ruff check src tests tools
+
+test:
+	$(PYTHON) -m pytest
+
+# Fixtures are generated, never committed: the generator is the source of truth.
+fixtures:
+	$(PYTHON) tools/make_fixtures.py
+
+corpus:
+	$(PYTHON) tools/vendor_corpus.py --check
+
+coverage-check:
+	$(PYTHON) tools/rule_coverage.py --check
+
+# A downstream packager builds from the sdist. If the sdist cannot run the gate,
+# they get a green build that checked nothing — the same shape as a gate that
+# reads a path outside the repository.
+sdist-runs-its-own-tests:
+	$(PYTHON) tools/check_sdist.py
+
+clean:
+	rm -rf .pytest_cache .ruff_cache build dist tests/fixtures **/__pycache__

vdi2770_validate-0.1.0/NOTICE

@@ -0,0 +1,45 @@
+vdi2770-validate
+Copyright 2026 Wooyong Lee
+
+This product includes software developed by Wooyong Lee.
+Licensed under the Apache License, Version 2.0.
+
+--------------------------------------------------------------------------
+Third-party material bundled with this project
+--------------------------------------------------------------------------
+
+1. VDI 2770 XML schema — src/vdi2770_validate/data/VDI2770_Schema_2019-08-23.xsd
+
+   Published free of charge by VDI (Verein Deutscher Ingenieure) on the
+   VDI 2770 guideline programme page. Redistributed verbatim, unmodified.
+   Retrieved 2026-08-21 from
+   https://www.vdi.de/fileadmin/pages/vdi_de/redakteure/richtlinien/dateien/vdi2770/VDI_2770_1_de_Deklaration_des_XML-Schemas_-_Declaration_of_the_XML_model.xsd
+   The download page states no licence or terms of use. The file is treated
+   as VDI's work and is redistributed unchanged. See docs/licensing.md.
+
+2. VDI 2770 document class table — src/vdi2770_validate/data/document-classes.json
+
+   Table 1 of IDTA 02004 "Handover Documentation", Version 2.0.1 (November 2025),
+   Industrial Digital Twin Association e.V., published in
+   github.com/admin-shell-io/submodel-templates under CC BY 4.0.
+   Modified: the twelve rows were extracted and reformatted as JSON.
+   https://creativecommons.org/licenses/by/4.0/
+
+3. Reference message catalogue — tests/data/oracle-messages.json
+
+   The English validation messages of the same reference implementation,
+   reproduced so the licensing gate in tests/test_catalogue.py can check that no
+   remedy text in this project was copied from them. Test data only; nothing in
+   the shipped package reads it.
+   MIT License, Copyright (C) 2021 Johannes Schmidt.
+
+4. Conformance corpus — corpus/
+
+   Copied from github.com/DigitalDataChainConsortium/vdi2770 (examples/),
+   MIT License, Copyright (C) 2021 Johannes Schmidt. See corpus/NOTICE.
+
+The text of the VDI 2770 guideline itself (VDI 2770 Blatt 1:2020-04) is sold
+by DIN Media and is NOT included, quoted, or paraphrased anywhere in this
+project. See docs/licensing.md.
+
+Full provenance, licence texts and modification statements: THIRD_PARTY.md

vdi2770_validate-0.1.0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: vdi2770-validate
+Version: 0.1.0
+Summary: Offline conformance checker for VDI 2770 containers — every finding comes with a remedy
+Author: Wooyong Lee
+License: Apache-2.0
+Keywords: vdi2770,technical documentation,conformance,validation,industry 4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Manufacturing
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+License-File: THIRD_PARTY.md
+Requires-Dist: xmlschema==4.2.0
+Provides-Extra: dev
+Requires-Dist: pytest==8.3.4; extra == "dev"
+Requires-Dist: ruff==0.16.3; extra == "dev"
+Dynamic: license-file
+
+# vdi2770-validate
+
+Point it at a VDI 2770 container and it tells you, offline, whether the archive is
+one — and if something is wrong, what to do about it.
+
+VDI 2770 is how manufacturers hand over technical documentation in the process
+industry: PDFs bundled into ZIP "document containers" with an XML metadata file,
+those bundled into a "documentation container". Operators in the process industry
+increasingly ask for it in purchase orders, and a container rejected on intake holds
+up a delivery. The reference implementation is a Java library and web service; this
+is a small offline CLI you can drop into a CI job.
+
+**Unofficial.** Not affiliated with VDI, the Digital Data Chain Consortium, or IDTA.
+Names are used descriptively.
+
+```
+$ vdi2770-validate check corpus/examples/missingdocuments/folders.zip
+  error  F1  A file named in the metadata is not in the container
+         at folders.zip!/VDI2770_Main.xml:56:2
+         'VDI2770_Main.pdf' is declared but not in the archive
+         -> Add the missing file to the container, or remove its DigitalFile entry from the metadata. The two must agree.
+  error  Z7  The documentation container has no VDI2770_Main.pdf
+         at folders.zip
+         -> Add the main document as VDI2770_Main.pdf at the root of the documentation container, next to VDI2770_Main.xml.
+  warn   F2  A file in the container is not named in the metadata
+         at folders.zip!/456-29201/VDI2770_Metadata.xml
+         -> Declare the file as a DigitalFile in the metadata, or remove it from the container. An undeclared file is invisible to the recipient's system.
+  warn   F2  A file in the container is not named in the metadata
+         at folders.zip!/456-29201/demo.pdf
+         -> Declare the file as a DigitalFile in the metadata, or remove it from the container. An undeclared file is invisible to the recipient's system.
+  warn   F2  A file in the container is not named in the metadata
+         at folders.zip!/456-29201/demo.xlsx
+         -> Declare the file as a DigitalFile in the metadata, or remove it from the container. An undeclared file is invisible to the recipient's system.
+  warn   F2  A file in the container is not named in the metadata
+
+  … 6 more warnings of the same kind
+```
+
+That is real output on a container that ships with this repository, so the same command works after cloning.
+
+## What it will not tell you
+
+**Whether a PDF really is PDF/A.** That needs a full PDF/A validator such as
+veraPDF. This tool reports what a file *claims*, which catches the common failure:
+files that never claimed at all. It says so on every line where it matters, and the
+JSON output carries `"pdfaVerified": false` on every path. The rest of the refusals
+are in [docs/scope.md](docs/scope.md).
+
+## How it is built
+
+- **Offline by design.** No network at runtime, proven by a test that makes sockets
+  raise. Nothing is extracted to disk; a supplier archive does not get to pick a
+  path on your filesystem or expand an XML entity.
+- **Rules are data.** [`rules.json`](src/vdi2770_validate/data/rules.json) — each
+  rule carries where its requirement comes from, a remedy sentence, and — where the
+  reference implementation checks the same thing — the message keys it uses.
+- **22 of 32 rules have a minimal fixture pair** — a container that violates the rule
+  and a conforming one differing in as little as a single member. The rest are exercised
+  by the vendored corpus. A rule that fires nowhere fails the build.
+- **Rules cannot reach the parser.** A test fails if a rule module imports `zipfile`
+  or an XML library, so a rule cannot accidentally check how a document was spelled
+  instead of what it says. Rules may name the readers' reserved file names, nothing more.
+
+## The classification table, and a disagreement
+
+VDI 2770 defines twelve document classes. Two sources publish that table for free —
+IDTA 02004 v2.0.1 Table 1, and the MIT reference implementation. Both renderings of
+every name are stored, so you can check rather than trust: **they agree on all twelve
+German names and disagree on five English ones** (02-03, 02-04, 03-01, 03-04,
+04-01). So matching here is keyed on the class id and the German name, and an
+English name never fails a document — it produces a note that shows both renderings.
+
+```
+$ vdi2770-validate classes
+02-03  Bauteile    Assemblies   [sources disagree]
+      IDTA 02004: 'Assemblies'   reference impl: 'Components'
+```
+
+Details in [docs/divergences.md](docs/divergences.md).
+
+## Licensing
+
+Apache-2.0. The VDI 2770 guideline text is sold by DIN Media and was **not** read,
+quoted, or paraphrased. Every rule names its source in `rules.json` instead: the schema
+VDI publishes free, a freely published table, ZIP and XML mechanics, the MIT reference
+implementation (observed there, not verified against the standard), or a judgement of
+our own that has to explain itself.
+See [docs/licensing.md](docs/licensing.md) and [NOTICE](NOTICE).
+
+Contributions take a `Signed-off-by` line (DCO).
+
+## Related
+
+[iirds-validate](https://github.com/dev365code/iirds-validate) — the same idea for
+iiRDS. [standards-watch](https://github.com/dev365code/standards-watch) — a daily
+watch on these standards.