aas-submodel-validate 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (110) hide show
  1. aas_submodel_validate-0.1.0/.github/workflows/ci.yml +127 -0
  2. aas_submodel_validate-0.1.0/.github/workflows/dco.yml +29 -0
  3. aas_submodel_validate-0.1.0/.github/workflows/release.yml +104 -0
  4. aas_submodel_validate-0.1.0/CHANGELOG.md +49 -0
  5. aas_submodel_validate-0.1.0/CONTRIBUTING.md +69 -0
  6. aas_submodel_validate-0.1.0/LICENSE +202 -0
  7. aas_submodel_validate-0.1.0/MANIFEST.in +17 -0
  8. aas_submodel_validate-0.1.0/Makefile +48 -0
  9. aas_submodel_validate-0.1.0/NOTICE +19 -0
  10. aas_submodel_validate-0.1.0/PKG-INFO +176 -0
  11. aas_submodel_validate-0.1.0/README.md +151 -0
  12. aas_submodel_validate-0.1.0/SECURITY.md +22 -0
  13. aas_submodel_validate-0.1.0/THIRD_PARTY.md +55 -0
  14. aas_submodel_validate-0.1.0/docs/divergences.md +47 -0
  15. aas_submodel_validate-0.1.0/docs/report-schema.md +151 -0
  16. aas_submodel_validate-0.1.0/docs/rule-coverage.json +128 -0
  17. aas_submodel_validate-0.1.0/docs/scope.md +45 -0
  18. aas_submodel_validate-0.1.0/pyproject.toml +63 -0
  19. aas_submodel_validate-0.1.0/setup.cfg +4 -0
  20. aas_submodel_validate-0.1.0/src/aas_submodel_validate/__init__.py +4 -0
  21. aas_submodel_validate-0.1.0/src/aas_submodel_validate/__main__.py +5 -0
  22. aas_submodel_validate-0.1.0/src/aas_submodel_validate/cli.py +85 -0
  23. aas_submodel_validate-0.1.0/src/aas_submodel_validate/container.py +576 -0
  24. aas_submodel_validate-0.1.0/src/aas_submodel_validate/data/smt/02003/2.0.1/sha256sums.txt +1 -0
  25. aas_submodel_validate-0.1.0/src/aas_submodel_validate/data/smt/02003/2.0.1/template.json +4546 -0
  26. aas_submodel_validate-0.1.0/src/aas_submodel_validate/data/smt/02004/2.0.1/sha256sums.txt +1 -0
  27. aas_submodel_validate-0.1.0/src/aas_submodel_validate/data/smt/02004/2.0.1/template.json +4235 -0
  28. aas_submodel_validate-0.1.0/src/aas_submodel_validate/data/smt/02035-2/1.0/sha256sums.txt +1 -0
  29. aas_submodel_validate-0.1.0/src/aas_submodel_validate/data/smt/02035-2/1.0/template.json +2991 -0
  30. aas_submodel_validate-0.1.0/src/aas_submodel_validate/loader.py +337 -0
  31. aas_submodel_validate-0.1.0/src/aas_submodel_validate/model.py +223 -0
  32. aas_submodel_validate-0.1.0/src/aas_submodel_validate/registry.py +48 -0
  33. aas_submodel_validate-0.1.0/src/aas_submodel_validate/report.py +71 -0
  34. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/__init__.py +2 -0
  35. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/battery.py +242 -0
  36. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/battery_tables.py +163 -0
  37. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/container.py +157 -0
  38. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/dbp.py +50 -0
  39. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/dbp_tables.py +386 -0
  40. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/detect.py +118 -0
  41. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/engine.py +324 -0
  42. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/handover.py +512 -0
  43. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/hd.py +53 -0
  44. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/hd_tables.py +647 -0
  45. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/profiles.py +276 -0
  46. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/td.py +152 -0
  47. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/td_tables.py +448 -0
  48. aas_submodel_validate-0.1.0/src/aas_submodel_validate/rules/values.py +62 -0
  49. aas_submodel_validate-0.1.0/src/aas_submodel_validate/runner.py +210 -0
  50. aas_submodel_validate-0.1.0/src/aas_submodel_validate/semantics.py +132 -0
  51. aas_submodel_validate-0.1.0/src/aas_submodel_validate.egg-info/PKG-INFO +176 -0
  52. aas_submodel_validate-0.1.0/src/aas_submodel_validate.egg-info/SOURCES.txt +108 -0
  53. aas_submodel_validate-0.1.0/src/aas_submodel_validate.egg-info/dependency_links.txt +1 -0
  54. aas_submodel_validate-0.1.0/src/aas_submodel_validate.egg-info/entry_points.txt +3 -0
  55. aas_submodel_validate-0.1.0/src/aas_submodel_validate.egg-info/requires.txt +5 -0
  56. aas_submodel_validate-0.1.0/src/aas_submodel_validate.egg-info/top_level.txt +1 -0
  57. aas_submodel_validate-0.1.0/tests/builders.py +531 -0
  58. aas_submodel_validate-0.1.0/tests/conftest.py +43 -0
  59. aas_submodel_validate-0.1.0/tests/corpus/idta/02003/sample-2.0.1.aasx +0 -0
  60. aas_submodel_validate-0.1.0/tests/corpus/idta/02003/sample-2.0.aasx +0 -0
  61. aas_submodel_validate-0.1.0/tests/corpus/idta/02003/sample-2.0.json +4695 -0
  62. aas_submodel_validate-0.1.0/tests/corpus/idta/02003/sha256sums.txt +3 -0
  63. aas_submodel_validate-0.1.0/tests/corpus/idta/02004/example.aasx +0 -0
  64. aas_submodel_validate-0.1.0/tests/corpus/idta/02004/example.json +7387 -0
  65. aas_submodel_validate-0.1.0/tests/corpus/idta/02004/sha256sums.txt +2 -0
  66. aas_submodel_validate-0.1.0/tests/corpus/idta/README.md +18 -0
  67. aas_submodel_validate-0.1.0/tests/test_battery_rules.py +448 -0
  68. aas_submodel_validate-0.1.0/tests/test_ci_parity.py +97 -0
  69. aas_submodel_validate-0.1.0/tests/test_cli.py +42 -0
  70. aas_submodel_validate-0.1.0/tests/test_cli_flags.py +295 -0
  71. aas_submodel_validate-0.1.0/tests/test_container.py +124 -0
  72. aas_submodel_validate-0.1.0/tests/test_dbp_hand_rules.py +129 -0
  73. aas_submodel_validate-0.1.0/tests/test_dbp_rules.py +132 -0
  74. aas_submodel_validate-0.1.0/tests/test_dbp_tables.py +187 -0
  75. aas_submodel_validate-0.1.0/tests/test_decisions_are_pinned.py +139 -0
  76. aas_submodel_validate-0.1.0/tests/test_detect.py +206 -0
  77. aas_submodel_validate-0.1.0/tests/test_engine_regressions.py +592 -0
  78. aas_submodel_validate-0.1.0/tests/test_engine_seam.py +90 -0
  79. aas_submodel_validate-0.1.0/tests/test_generated_rules.py +156 -0
  80. aas_submodel_validate-0.1.0/tests/test_generated_rules_td.py +98 -0
  81. aas_submodel_validate-0.1.0/tests/test_hand_rules.py +864 -0
  82. aas_submodel_validate-0.1.0/tests/test_hand_rules_td.py +297 -0
  83. aas_submodel_validate-0.1.0/tests/test_hostile_input.py +1254 -0
  84. aas_submodel_validate-0.1.0/tests/test_loader.py +292 -0
  85. aas_submodel_validate-0.1.0/tests/test_meta_channel.py +46 -0
  86. aas_submodel_validate-0.1.0/tests/test_model.py +349 -0
  87. aas_submodel_validate-0.1.0/tests/test_official_material.py +162 -0
  88. aas_submodel_validate-0.1.0/tests/test_official_material_td.py +69 -0
  89. aas_submodel_validate-0.1.0/tests/test_pack_roster.py +208 -0
  90. aas_submodel_validate-0.1.0/tests/test_package.py +7 -0
  91. aas_submodel_validate-0.1.0/tests/test_part_names.py +378 -0
  92. aas_submodel_validate-0.1.0/tests/test_profiles.py +559 -0
  93. aas_submodel_validate-0.1.0/tests/test_provenance.py +106 -0
  94. aas_submodel_validate-0.1.0/tests/test_readme_front.py +207 -0
  95. aas_submodel_validate-0.1.0/tests/test_registry.py +764 -0
  96. aas_submodel_validate-0.1.0/tests/test_report_order.py +247 -0
  97. aas_submodel_validate-0.1.0/tests/test_report_schema_doc.py +138 -0
  98. aas_submodel_validate-0.1.0/tests/test_rules_container.py +28 -0
  99. aas_submodel_validate-0.1.0/tests/test_runner.py +26 -0
  100. aas_submodel_validate-0.1.0/tests/test_semantics.py +119 -0
  101. aas_submodel_validate-0.1.0/tests/test_spec_accuracy.py +340 -0
  102. aas_submodel_validate-0.1.0/tests/test_td_tables.py +89 -0
  103. aas_submodel_validate-0.1.0/tests/test_values.py +231 -0
  104. aas_submodel_validate-0.1.0/tools/battery_data_check.py +139 -0
  105. aas_submodel_validate-0.1.0/tools/build_zipapp.py +200 -0
  106. aas_submodel_validate-0.1.0/tools/check_distributions.py +184 -0
  107. aas_submodel_validate-0.1.0/tools/extract_battery_rules.py +229 -0
  108. aas_submodel_validate-0.1.0/tools/extract_smt_rules.py +377 -0
  109. aas_submodel_validate-0.1.0/tools/rule_coverage.py +66 -0
  110. aas_submodel_validate-0.1.0/tools/vendor_template.py +164 -0
@@ -0,0 +1,127 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+
8
+ permissions:
9
+ contents: read
10
+
11
+ concurrency:
12
+ group: ${{ github.workflow }}-${{ github.ref }}
13
+ cancel-in-progress: true
14
+
15
+ jobs:
16
+ lint:
17
+ runs-on: ubuntu-latest
18
+ steps:
19
+ - uses: actions/checkout@v4
20
+ - uses: actions/setup-python@v5
21
+ with:
22
+ python-version: "3.12"
23
+ - run: pip install ruff==0.16.3
24
+ - run: ruff check .
25
+ - run: pip install -e .
26
+ - name: the generated rule table matches its generator
27
+ run: python tools/extract_smt_rules.py --check
28
+ - name: the vendored official material matches its recorded hashes
29
+ run: python tools/vendor_template.py --check
30
+ - name: readers the battery-passport extractors import
31
+ run: pip install openpyxl pymupdf
32
+ - name: the battery-passport indexes agree with themselves
33
+ run: python tools/battery_data_check.py
34
+ - name: the battery rule table matches its generator
35
+ run: python tools/extract_battery_rules.py --check
36
+
37
+ test:
38
+ name: py${{ matrix.python }} ${{ matrix.label }} on ${{ matrix.os }}
39
+ runs-on: ${{ matrix.os }}
40
+ strategy:
41
+ fail-fast: false
42
+ matrix:
43
+ include:
44
+ - { os: ubuntu-latest, python: "3.9" }
45
+ - { os: ubuntu-latest, python: "3.10" }
46
+ - { os: ubuntu-latest, python: "3.11" }
47
+ - { os: ubuntu-latest, python: "3.12" }
48
+ # aas-core3.0's own CI matrix stops at 3.12, so this row is the
49
+ # floor dependency's first verdict on 3.13 -- a failure here is
50
+ # information, not noise.
51
+ - { os: ubuntu-latest, python: "3.13" }
52
+ # pyproject declares aas-core3.0>=1.1.4, so 1.1.4 exactly is what
53
+ # this row runs: a floor test that floats stops testing the floor.
54
+ - { os: ubuntu-latest, python: "3.11", pin: "aas-core3.0==1.1.4", label: "floor" }
55
+ # Windows is where an unclosed ZIP handle keeps files locked, and
56
+ # where a checkout could hand the suite different bytes than the
57
+ # ones whose hashes were recorded.
58
+ - { os: windows-latest, python: "3.11" }
59
+ steps:
60
+ - uses: actions/checkout@v4
61
+ - uses: actions/setup-python@v5
62
+ with:
63
+ python-version: ${{ matrix.python }}
64
+ - run: pip install -e ".[dev]"
65
+ - if: matrix.pin
66
+ run: pip install "${{ matrix.pin }}"
67
+ - run: pytest -q
68
+ - name: every rule id fired somewhere
69
+ run: python tools/rule_coverage.py --check
70
+ # Also in the lint job, deliberately: this one runs on every OS in
71
+ # the matrix, and end-of-line damage is a property of the checkout,
72
+ # not of the commit. A hash verified only where the file was written
73
+ # verifies nothing about the machine that unpacks it.
74
+ - name: the vendored bytes survived this checkout
75
+ run: python tools/vendor_template.py --check
76
+
77
+ wheel:
78
+ # The failure this exists for: a wheel that installs but is missing the
79
+ # vendored template, so the tool works from a checkout and its NOTICE
80
+ # lies about what it ships. Nothing in the test suite (editable install)
81
+ # would notice.
82
+ name: installed wheel
83
+ runs-on: ubuntu-latest
84
+ steps:
85
+ - uses: actions/checkout@v4
86
+ - uses: actions/setup-python@v5
87
+ with:
88
+ python-version: "3.12"
89
+ - run: pip install build
90
+ - run: python -m build --wheel --outdir dist/
91
+ - name: the wheel must carry the vendored template and not the corpus
92
+ run: |
93
+ python - <<'PY'
94
+ import glob, sys, zipfile
95
+ names = set(zipfile.ZipFile(glob.glob("dist/*.whl")[0]).namelist())
96
+ required = [
97
+ "aas_submodel_validate/data/smt/02004/2.0.1/template.json",
98
+ "aas_submodel_validate/data/smt/02004/2.0.1/sha256sums.txt",
99
+ "aas_submodel_validate/data/smt/02003/2.0.1/template.json",
100
+ "aas_submodel_validate/data/smt/02003/2.0.1/sha256sums.txt",
101
+ "aas_submodel_validate/data/smt/02035-2/1.0/template.json",
102
+ "aas_submodel_validate/data/smt/02035-2/1.0/sha256sums.txt",
103
+ ]
104
+ missing = [n for n in required if n not in names]
105
+ if missing:
106
+ sys.exit("missing from the wheel: %s" % missing)
107
+ strays = sorted(n for n in names if "corpus" in n or n.startswith("tests/"))
108
+ if strays:
109
+ sys.exit("the wheel carries test material it should not: %s" % strays[:5])
110
+ print("wheel carries the template, and no corpus")
111
+ PY
112
+ - name: no distribution carries what it must not
113
+ # The same check the release runs. Here on every push, because a
114
+ # release line first exercised on the day of the release is one
115
+ # that dies on the day of the release.
116
+ run: python tools/check_distributions.py
117
+ - name: the single file builds twice to the same bytes and answers
118
+ run: |
119
+ python tools/build_zipapp.py -o dist/smtv.pyz --check
120
+ python tools/build_zipapp.py -o /tmp/again.pyz
121
+ cmp dist/smtv.pyz /tmp/again.pyz
122
+ - name: install into a clean environment and smoke-test
123
+ run: |
124
+ python -m venv /tmp/v
125
+ /tmp/v/bin/pip install --quiet dist/*.whl
126
+ /tmp/v/bin/smtv --version
127
+ /tmp/v/bin/aas-submodel-validate --rules > /dev/null
@@ -0,0 +1,29 @@
1
+ # Every pull-request commit must carry a Signed-off-by line — the Developer
2
+ # Certificate of Origin, explained in CONTRIBUTING.md. Checked here rather
3
+ # than trusted, for the same reason everything else in this repository is.
4
+ name: dco
5
+
6
+ on: pull_request
7
+
8
+ permissions:
9
+ contents: read
10
+
11
+ jobs:
12
+ signoff:
13
+ name: every commit certifies its origin
14
+ runs-on: ubuntu-latest
15
+ steps:
16
+ - uses: actions/checkout@v4
17
+ with:
18
+ fetch-depth: 0
19
+ - name: look for Signed-off-by on each commit in the range
20
+ run: |
21
+ missing=0
22
+ for sha in $(git rev-list --no-merges \
23
+ "${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}"); do
24
+ if ! git log -1 --format=%B "$sha" | grep -Eq '^Signed-off-by: .+ <.+@.+>'; then
25
+ echo "::error::commit $sha has no Signed-off-by line (git commit -s; see CONTRIBUTING.md)"
26
+ missing=1
27
+ fi
28
+ done
29
+ exit "$missing"
@@ -0,0 +1,104 @@
1
+ # Runs when a version tag is pushed. Proves the tree green, builds the
2
+ # wheel, the sdist and the single file, proves the single file
3
+ # reproducible by building it twice, attaches everything to a GitHub
4
+ # Release with the checksums beside it -- for the air-gapped audience,
5
+ # "the hash on the release page is the hash of the file I carried in" is
6
+ # the entire trust story -- and then publishes the same bytes to PyPI.
7
+ #
8
+ # Until pypi.org trusts this repository for this project, the publish job
9
+ # fails visibly, on purpose, without touching the GitHub Release above.
10
+ name: release
11
+
12
+ on:
13
+ push:
14
+ tags: ["v*"]
15
+
16
+ permissions:
17
+ contents: read
18
+
19
+ jobs:
20
+ build:
21
+ runs-on: ubuntu-latest
22
+ permissions:
23
+ contents: write
24
+ steps:
25
+ - uses: actions/checkout@v4
26
+ - uses: actions/setup-python@v5
27
+ with:
28
+ python-version: "3.12"
29
+
30
+ - name: the tag and the version agree
31
+ # Three places say the version -- the package, the tag and the
32
+ # CHANGELOG -- and a release where they disagree is one nobody
33
+ # can cite later.
34
+ run: |
35
+ pip install -e ".[dev]"
36
+ v="$(python -c 'import aas_submodel_validate as m; print(m.__version__)')"
37
+ [ "$GITHUB_REF_NAME" = "v$v" ] || { echo "tag $GITHUB_REF_NAME != version $v"; exit 1; }
38
+ heading="$(grep -m1 "^## $v — " CHANGELOG.md)" || { echo "CHANGELOG has no heading for $v"; exit 1; }
39
+ case "$heading" in
40
+ *unreleased*) echo "CHANGELOG still says: $heading"; exit 1 ;;
41
+ esac
42
+ echo "$heading" | grep -qE ' — [0-9]{4}-[0-9]{2}-[0-9]{2}$' \
43
+ || { echo "CHANGELOG heading carries no date: $heading"; exit 1; }
44
+
45
+ - name: everything must be green first
46
+ # The readers the battery extractors import are installed here
47
+ # too, not only in CI. Without them that gate reports a skip and
48
+ # passes -- so a release would have run a weaker check than every
49
+ # push that led to it, which is the wrong way round.
50
+ run: |
51
+ pip install openpyxl pymupdf
52
+ make check
53
+
54
+ - name: build the wheel and the sdist
55
+ run: |
56
+ pip install build
57
+ python -m build
58
+
59
+ - name: no distribution carries what it must not
60
+ # Nothing this repository does not track, and not the
61
+ # requirements indexes -- asked of what the archives contain.
62
+ run: python tools/check_distributions.py
63
+
64
+ - name: build the single file twice; the hashes must match
65
+ run: |
66
+ python tools/build_zipapp.py -o dist/smtv.pyz --check
67
+ python tools/build_zipapp.py -o /tmp/again.pyz
68
+ cmp dist/smtv.pyz /tmp/again.pyz
69
+ echo "reproducible: yes"
70
+
71
+ - name: one checksum file beside them
72
+ run: cd dist && shasum -a 256 * > SHA256SUMS && cat SHA256SUMS
73
+
74
+ # The publisher below uploads exactly these bytes; nothing is rebuilt.
75
+ - uses: actions/upload-artifact@v4
76
+ with:
77
+ name: dist
78
+ path: dist/
79
+ if-no-files-found: error
80
+
81
+ - name: attach them to a GitHub Release
82
+ env:
83
+ GH_TOKEN: ${{ github.token }}
84
+ run: |
85
+ gh release create "$GITHUB_REF_NAME" dist/* \
86
+ --title "$GITHUB_REF_NAME" \
87
+ --notes "See CHANGELOG.md. Verify what you download: \`shasum -a 256 -c SHA256SUMS\`. The .pyz needs only a Python — \`python smtv.pyz your-submodel.aasx\`; it reaches no network and neither does the tool."
88
+
89
+ publish:
90
+ needs: build
91
+ runs-on: ubuntu-latest
92
+ environment: pypi
93
+ permissions:
94
+ id-token: write
95
+ steps:
96
+ - uses: actions/download-artifact@v4
97
+ with:
98
+ name: dist
99
+ path: dist
100
+ - name: only the wheel and the sdist go to PyPI
101
+ run: mkdir up && cp dist/aas_submodel_validate-*.whl dist/aas_submodel_validate-*.tar.gz up/
102
+ - uses: pypa/gh-action-pypi-publish@release/v1
103
+ with:
104
+ packages-dir: up
@@ -0,0 +1,49 @@
1
+ # Changelog
2
+
3
+ ## 0.1.0 — 2026-09-04
4
+
5
+ First release: 125 rules, 123 of them across three IDTA templates — *Handover
6
+ Documentation* 2.0.1, *Technical Data* 2.0.1 and *Digital Battery
7
+ Passport part 2* 1.0 — of which 86 are generated from the vendored
8
+ official template files. The `meta` channel
9
+ relays aas-core3.0's metamodel verification rather than restating it;
10
+ four input forms are read (.aasx with XML or JSON payload, environment
11
+ .json/.xml, bare Submodel .json); XML arrives in whichever encoding the
12
+ parser reads — UTF-8 or UTF-16, marked or not — and is decoded that way
13
+ before the DTD refusal looks at it, so the refusal covers what the
14
+ parser covers; every finding carries a remedy
15
+ sentence; and the official example is pinned by name — defects and all.
16
+ What this reader takes in is bounded whichever way a document arrives —
17
+ one document at 64 MiB, a container's parts at 64 MiB each and 256 MiB
18
+ together, and a container's directory of names at 16 MiB, which is a
19
+ different kind of cost: a ZIP is indexed whole before any of it is read,
20
+ so it falls on how many names an archive declares rather than on what its
21
+ entries hold — and what it refuses to read, it does not judge: `summary.complete`
22
+ in the JSON report and a clause on the terminal summary say when the
23
+ counts describe less than the whole input. `summary.judged` says the
24
+ sharper thing beside it — whether anything reached the rules at all — and
25
+ an input that was refused rather than judged leaves by the could-not-run
26
+ exit code, 2, where it used to leave by the code for a verdict. Both
27
+ fields are additive, so `schemaVersion` stays 1.
28
+ IDTA 02035-2 shares 02004's submodel identifier, so `--profile` chooses
29
+ which of the two answers and SMT-D2 reports the choice; without the flag
30
+ 02004 answers. `rulesChecked` in the JSON report counts every registered
31
+ rule, so it counts all 125 whichever template answered.
32
+ Two rules read the battery passport against Regulation (EU) 2023/1542
33
+ rather than against a template, from a table generated out of the
34
+ requirements indexes published in `data/battery-passport/`: `BAT-R2`
35
+ names a submodel identifier two published templates claim and this tool
36
+ has a table for neither of, and `BAT-R8` reports an element the template
37
+ permits to be absent that a legal reading requires of every battery
38
+ category. Eight further disagreements are known and not reported,
39
+ because whether the law requires them depends on a category no rule here
40
+ reads; the report counts them rather than keeping quiet about them. Both
41
+ rules are warnings — two published readings of applicability exist and
42
+ this pack cannot yet be told which to answer for.
43
+
44
+ The JSON report's shape is written down in `docs/report-schema.md`, and
45
+ carries two more fields: `toolVersion`, because the shape's number and
46
+ the producer's are different numbers and a defect report needs the
47
+ second; and `options`, because the flags move the verdict — the same file
48
+ comes back `ok` under one set and not another — and two reports that did
49
+ not say which run they were could not be compared.
@@ -0,0 +1,69 @@
1
+ # Contributing
2
+
3
+ ## Certify your commits (DCO)
4
+
5
+ Every commit needs a sign-off line:
6
+
7
+ ```
8
+ Signed-off-by: Your Name <you@example.com>
9
+ ```
10
+
11
+ `git commit -s` writes it for you; `git commit --amend -s` repairs a
12
+ forgotten one. The line certifies the [Developer Certificate of
13
+ Origin 1.1](https://developercertificate.org/) — that you wrote the change
14
+ or otherwise have the right to submit it under this project's licence. That
15
+ is the whole deal: you keep your copyright, your contribution arrives under
16
+ Apache-2.0 like everything here (inbound = outbound), and the project keeps
17
+ a provenance trail it can show anyone who asks — which, for a tool courting
18
+ a standards body, someone eventually will. There is no CLA and no paperwork;
19
+ a certificate of origin is a statement of fact, not a transfer of rights.
20
+
21
+ Pull requests are checked for the line automatically.
22
+
23
+ The certificate, verbatim:
24
+
25
+ ```
26
+ Developer Certificate of Origin
27
+ Version 1.1
28
+
29
+ Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
30
+
31
+ Everyone is permitted to copy and distribute verbatim copies of this
32
+ license document, but changing it is not allowed.
33
+
34
+
35
+ Developer's Certificate of Origin 1.1
36
+
37
+ By making a contribution to this project, I certify that:
38
+
39
+ (a) The contribution was created in whole or in part by me and I
40
+ have the right to submit it under the open source license
41
+ indicated in the file; or
42
+
43
+ (b) The contribution is based upon previous work that, to the best
44
+ of my knowledge, is covered under an appropriate open source
45
+ license and I have the right under that license to submit that
46
+ work with modifications, whether created in whole or in part
47
+ by me, under the same open source license (unless I am
48
+ permitted to submit under a different license), as indicated
49
+ in the file; or
50
+
51
+ (c) The contribution was provided directly to me by some other
52
+ person who certified (a), (b) or (c) and I have not modified
53
+ it.
54
+
55
+ (d) I understand and agree that this project and the contribution
56
+ are public and that a record of the contribution (including all
57
+ personal information I submit with it, including my sign-off) is
58
+ maintained indefinitely and may be redistributed consistent with
59
+ this project or the open source license(s) involved.
60
+ ```
61
+
62
+ ## Adding a rule
63
+
64
+ A rule is born red: commit a fixture that violates it and one that does
65
+ not, watch the violation test fail, then implement. Every rule carries a
66
+ `fix` sentence — what to change so the finding stops being reported, not
67
+ the requirement restated in the imperative — and every rule id must fire
68
+ somewhere in the suite. Match by semanticId, never by idShort
69
+ (docs/divergences.md explains why, with the template's own words).
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2026 Wooyong Lee (dev365code)
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,17 @@
1
+ # A downstream packager who unpacks the sdist and runs pytest must find a
2
+ # runnable suite -- so conftest, the builders, the vendored corpus and the
3
+ # tools the tests import all ship, not just the test_*.py files setuptools
4
+ # would include on its own.
5
+ graft tests
6
+ graft tools
7
+ graft docs
8
+ graft .github
9
+ include Makefile MANIFEST.in
10
+ include CONTRIBUTING.md SECURITY.md NOTICE THIRD_PARTY.md CHANGELOG.md
11
+ global-exclude __pycache__/* *.pyc
12
+ recursive-exclude tests .rule-coverage.json
13
+
14
+ # Working notes are not part of the distribution.
15
+ exclude CLAUDE.md AGENTS.md
16
+ prune .claude
17
+ exclude docs/findings.md docs/audits.md
@@ -0,0 +1,48 @@
1
+ # Everything CI's lint and test gates run, runnable before you push, because a
2
+ # gate that exists in one place and not the other fails quietly in the
3
+ # dangerous direction. tests/test_ci_parity.py holds the two in step.
4
+
5
+ RUFF_VERSION := 0.16.3
6
+ PYTHON ?= python3
7
+ export PYTHONPATH := $(CURDIR)/src:$(CURDIR)/tests
8
+
9
+ .PHONY: help check test lint fix dev generated vendored exercised
10
+
11
+ help:
12
+ @echo "make check everything CI runs: lint, gates, the test suite"
13
+ @echo "make test the test suite alone"
14
+ @echo "make lint ruff, pinned to the version CI uses"
15
+ @echo "make generated the generated rule table still matches its generator"
16
+ @echo "make vendored the vendored official material matches its hashes"
17
+ @echo "make exercised every rule id fired somewhere in the suite"
18
+ @echo "make fix ruff --fix, for what it can correct itself"
19
+ @echo "make dev install the pinned dev tools"
20
+
21
+ check: lint generated vendored battery-data test exercised
22
+
23
+ generated:
24
+ $(PYTHON) tools/extract_smt_rules.py --check
25
+
26
+ vendored:
27
+ $(PYTHON) tools/vendor_template.py --check
28
+
29
+ exercised:
30
+ $(PYTHON) tools/rule_coverage.py --check
31
+
32
+ battery-data:
33
+ $(PYTHON) tools/battery_data_check.py
34
+ $(PYTHON) tools/extract_battery_rules.py --check
35
+
36
+ lint:
37
+ @$(PYTHON) -m ruff --version | grep -q "$(RUFF_VERSION)" \
38
+ || { echo "ruff $(RUFF_VERSION) required (make dev)"; exit 1; }
39
+ $(PYTHON) -m ruff check .
40
+
41
+ test:
42
+ $(PYTHON) -m pytest -q
43
+
44
+ fix:
45
+ $(PYTHON) -m ruff check --fix .
46
+
47
+ dev:
48
+ $(PYTHON) -m pip install --user "ruff==$(RUFF_VERSION)" "pytest>=7" "aas-core3.0>=1.1.4,<2"
@@ -0,0 +1,19 @@
1
+ aas-submodel-validate
2
+ Copyright 2026 Wooyong Lee
3
+
4
+ This distribution contains material from the IDTA submodel-templates
5
+ repository (https://github.com/admin-shell-io/submodel-templates),
6
+ licensed under the Creative Commons Attribution 4.0 International
7
+ License (CC BY 4.0, https://creativecommons.org/licenses/by/4.0/):
8
+
9
+ - src/aas_submodel_validate/data/smt/02004/2.0.1/template.json
10
+ (IDTA 02004-2-0-1 Handover Documentation template, unmodified)
11
+ - src/aas_submodel_validate/data/smt/02003/2.0.1/template.json
12
+ (IDTA 02003 2.0.1 Technical Data template, unmodified)
13
+ - src/aas_submodel_validate/data/smt/02035-2/1.0/template.json
14
+ (IDTA 02035-2 1.0 Digital Battery Passport part 2, Handover
15
+ Documentation template, unmodified)
16
+
17
+ Copyright for that material: Industrial Digital Twin Association (IDTA)
18
+ and the template's contributors. See THIRD_PARTY.md for the pinned
19
+ revision and verification hashes.