iirds 0.6.3

 Apache-2.0 · Python 3.9–3.13 · Linux · macOS · Windows · zero network, by design

Ten seconds · What it catches · The local web door · Where it sits · Five doors · Honest coverage · Roadmap · In your product

Ten seconds

$ pip install iirds

Three parts, every time: what is wrong → the evidence as read from your file → how to fix it. A rule without a prescription does not ship. The old distribution name iirds-validate and the short command iirdsv remain as aliases of the same package.

$ iirds manual.iirds
manual.iirds   iiRDS 1.3
  note: metadata read from META-INF/metadata.rdf

  ERROR M11       Rendition must have exactly one iirds:format
                      urn:example:manual has-rendition
                      0 found
                    → Give the Rendition exactly one iirds:format, holding the media type of the
                    → file it points at, for example application/xhtml+xml or application/pdf.
                    → Add one if there is none; remove the extras if there are several.
  WARN  L1        relation points at an IRI that is never described in this package
                      urn:example:event/al-204
                      referenced by Operating manual via relates-to-event
                    → Either describe the target in this package, or drop the reference. A
                    → relation pointing at an IRI nothing here mentions gives a consumer a name
                    → and no way to resolve it.

  FAIL  1 error(s), 1 warning(s), 0 informational
  187 rules checked, 24 not applicable to this version/variant (22 for iiRDS/H, 2 for other editions)
$ echo $?
1

What it catches

Every code carries a prescription and the section of the specification it enforces — iirds rules C5 -v shows any rule's source and remedy.

It asks whether the package will work, not only whether it conforms. Fifteen interoperability rules, most with no counterpart in the specification, because a conformant package can still be undeliverable:

The local web door

For people who do not read terminals — that is literally what the help says:

$ iirds serve

opens a drop page on your own machine: drag a package, read the verdict. Loopback only — any other host is refused by design. Nothing is uploaded anywhere, because there is nowhere to upload to.

Where it sits

flowchart LR
    A[Authoring · CCMS · DITA-OT] --> P([.iirds package])
    P --> C{{iirds check}}
    C -- "PASS" --> D[Delivery portal · customer]
    C -- "findings + remedies" --> A
    classDef ref fill:#2f5d8a,stroke:#2f5d8a,color:#ffffff
    class C ref

The referee between producer and receiver. Same file → same verdict, byte for byte — no uploads, no telemetry, no model in the judgement loop.

Five doors, one judgement

Honest coverage

At a glance — 211 rules across five editions and three profiles · 149 SHACL shapes carrying the language-neutral encoding · one pure-Python dependency (rdflib), zero for the single-file .pyz · every number in this section is read by a test that fails the build when it goes stale.

$ iirds rules
container  19/19    the ZIP and its layout  +3 of its own
schema     135/135  the metadata graph  +15 of its own
system     3/3      the run itself  +10 of its own
content    -        iiRDS XHTML5 (Appendix B)  +11 of its own
lint       -        will a consumer be able to use it  +15 of its own

157 of 157 catalogued rules, plus 54 of this project's own.

Coverage of the catalogue is not coverage of the standard. The specification states 280 absolute obligations, counted by tools/extract_requirements.py and listed in docs/requirements.json; the rules currently cover 131 of them — a floor, not a ceiling (docs/rule-coverage.json), re-measured on every release.

• Every finding says what to do about it. All 211 rules carry one imperative sentence naming the change, and a test refuses a rule that does not.
• Every rule has been watched fire. The suite records which rule ids actually produce a finding, and 210 of the 211 have — the remaining one is a MAY with nothing to violate.
• What is not established. The 54 rules this project invented have no second implementation to be compared against; docs/divergences.md records where this project reads the specification differently, with reasons.

Why trust the answer

• Deterministic — same file, same verdict, byte for byte.
• Offline — your documents never leave your machine.
• Self-tested — rules are verified against their own mutations before they ship.
• A public divergence ledger — where our reading differs, it is recorded with reasons.

Roadmap

An item moves right only when it is built and verified.

timeline
    title Where iirds is going
    Shipped : One package — validator + reader + writer
            : Local web door · reproducible single file
            : Findings with evidence and prescriptions
    Building : Coverage climb through the obligation index
             : Audit-ready evidence bundle in one command
             : Deeper iiRDS/H handover checks
    Planned : Browser-local validation — no install, nothing uploaded
            : Delivery checks across neighbouring standards
            : Format conversion under the same judgement

When iirds is not the tool

• Authoring or fixing content — iirds judges packages; it does not create them (though every finding tells you the fix).
• Certification — no tool can declare legal conformance. The declaration stays yours.
• Neighbouring standards — for VDI 2770 containers or AAS submodels, use the sibling judges built the same way: vdi2770-validate, aas-submodel-validate.

Using this validator in your product

Reading and writing packages from Python

import iirds, iirds_validate

pkg = iirds.open("release.iirds")               # reader: metadata graph, files
report = iirds_validate.check("release.iirds")  # the judge, as a function

The reader ships with one dependency and no verdicts; the judge imports the reader, never the other way around.

Stewardship

The iirds name on PyPI belongs to the standard's community more than to any one project. Should the iiRDS Consortium want this name for an official SDK, it will be transferred on request — until then it does real work rather than squatting. iirds-sdk is an alias of this package and travels under the same pledge.

This is an unofficial project, not affiliated with or endorsed by the iiRDS Consortium or tekom Deutschland e.V. "iiRDS" is used descriptively, to name the standard these functions read and write.

Licence

Apache-2.0 — see LICENSE.

The bundled iiRDS ontologies are © tekom Deutschland e.V. / iiRDS Consortium under CC BY-ND 4.0 and are redistributed verbatim; the rule catalogue is derived from plusmeta's MIT-licensed tool. CC BY-ND is not an OSI-approved licence, so this distribution is not wholly open source even though the code is — docs/licensing.md explains what that means for you and what would fix it. Provenance in NOTICE and THIRD_PARTY.md.

Not affiliated with, endorsed by, or certified by the iiRDS Consortium, tekom Deutschland e.V., plusmeta GmbH or Quanos Solutions GmbH. "iiRDS" is used descriptively to name the standard this tool validates against.

_{Numbers above are re-measured on every release · findings are judgements about files, never about people}