iirds 0.1.0__tar.gz

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

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: py${{ matrix.python }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ["3.9", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - run: pip install -e ".[dev]"
+      - run: ruff check .
+      - run: pytest -q

iirds-0.1.0/.github/workflows/dco.yml

@@ -0,0 +1,29 @@
+# Every pull-request commit must carry a Signed-off-by line — the Developer
+# Certificate of Origin, explained in CONTRIBUTING.md. Checked here rather
+# than trusted, for the same reason everything else in this repository is.
+name: dco
+
+on: pull_request
+
+permissions:
+  contents: read
+
+jobs:
+  signoff:
+    name: every commit certifies its origin
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: look for Signed-off-by on each commit in the range
+        run: |
+          missing=0
+          for sha in $(git rev-list --no-merges \
+              "${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}"); do
+            if ! git log -1 --format=%B "$sha" | grep -Eq '^Signed-off-by: .+ <.+@.+>'; then
+              echo "::error::commit $sha has no Signed-off-by line (git commit -s; see CONTRIBUTING.md)"
+              missing=1
+            fi
+          done
+          exit "$missing"

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

@@ -0,0 +1,52 @@
+# Tag v* → build and publish both distributions via Trusted Publishing
+# (OIDC, no tokens). Two jobs, two environments, because PyPI requires each
+# pending publisher's (repo, workflow, environment) tuple to be unique per
+# project name:
+#   project `iirds`      ← environment `pypi`
+#   project `iirds-sdk`  ← environment `pypi-sdk`
+name: release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  publish-iirds:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: |
+          pip install build
+          python -m build --outdir dist .
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+
+  publish-iirds-sdk:
+    # After the main package, so the alias's `iirds==X` pin resolves the
+    # moment it lands.
+    needs: publish-iirds
+    runs-on: ubuntu-latest
+    environment: pypi-sdk
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: |
+          pip install build
+          python -m build --outdir dist alias
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist

iirds-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+__pycache__/
+*.egg-info/
+dist/
+.pytest_cache/
+.ruff_cache/

iirds-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.

iirds-0.1.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.5
+Name: iirds
+Version: 0.1.0
+Summary: Read and write iiRDS packages. The seed of a community SDK, held in stewardship for the iiRDS ecosystem.
+Project-URL: Homepage, https://github.com/dev365code/iirds
+Project-URL: Validator, https://github.com/dev365code/iirds-validate
+Author-email: Wooyong Lee <zero8004paz@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: iirds,intelligent-information,rdf,technical-documentation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.9
+Requires-Dist: rdflib>=6
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# iirds
+
+Read and write [iiRDS](https://iirds.org) packages in Python.
+
+```sh
+pip install iirds
+```
+
+```python
+import iirds
+
+with iirds.open("machine-docs.iirds") as pkg:
+    print(pkg.version, pkg.variant)      # "1.3" "unrestricted"
+    graph = pkg.graph                    # rdflib.Graph of META-INF/metadata.rdf
+    data = pkg.read("content/topic1.xhtml")
+
+iirds.pack("my-package-directory/")     # → my-package-directory.iirds,
+                                         #   mimetype first and stored,
+                                         #   byte-identical on every run
+```
+
+Deliberately small: open a container, get the metadata as an RDF graph, read
+files, write a conformant container back. **It does not validate** — that is
+[iirds-validate](https://github.com/dev365code/iirds-validate)'s job (185
+rules, offline, CI-friendly), and keeping the two apart keeps this library at
+one dependency (rdflib).
+
+Two things the `pack()` half gets right that generic ZIP tooling gets wrong:
+the `mimetype` entry is first and stored uncompressed, and packing the same
+directory twice produces byte-identical output (honouring
+`SOURCE_DATE_EPOCH`), so "this archive came from that directory" is checkable
+with a hash instead of taken on trust.
+
+## 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.
+
+## API stability
+
+0.x: the surface will grow (query helpers, JSON-LD, writing metadata — in
+that rough order); what is published is intended not to break. The API is
+small on purpose — additions are cheap, retractions are not.
+
+## Licence
+
+Apache-2.0, © 2026 Wooyong Lee. Contributions need a `Signed-off-by` line
+(DCO); see the workflow in `.github/`.

iirds-0.1.0/README.md

@@ -0,0 +1,55 @@
+# iirds
+
+Read and write [iiRDS](https://iirds.org) packages in Python.
+
+```sh
+pip install iirds
+```
+
+```python
+import iirds
+
+with iirds.open("machine-docs.iirds") as pkg:
+    print(pkg.version, pkg.variant)      # "1.3" "unrestricted"
+    graph = pkg.graph                    # rdflib.Graph of META-INF/metadata.rdf
+    data = pkg.read("content/topic1.xhtml")
+
+iirds.pack("my-package-directory/")     # → my-package-directory.iirds,
+                                         #   mimetype first and stored,
+                                         #   byte-identical on every run
+```
+
+Deliberately small: open a container, get the metadata as an RDF graph, read
+files, write a conformant container back. **It does not validate** — that is
+[iirds-validate](https://github.com/dev365code/iirds-validate)'s job (185
+rules, offline, CI-friendly), and keeping the two apart keeps this library at
+one dependency (rdflib).
+
+Two things the `pack()` half gets right that generic ZIP tooling gets wrong:
+the `mimetype` entry is first and stored uncompressed, and packing the same
+directory twice produces byte-identical output (honouring
+`SOURCE_DATE_EPOCH`), so "this archive came from that directory" is checkable
+with a hash instead of taken on trust.
+
+## 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.
+
+## API stability
+
+0.x: the surface will grow (query helpers, JSON-LD, writing metadata — in
+that rough order); what is published is intended not to break. The API is
+small on purpose — additions are cheap, retractions are not.
+
+## Licence
+
+Apache-2.0, © 2026 Wooyong Lee. Contributions need a `Signed-off-by` line
+(DCO); see the workflow in `.github/`.

iirds-0.1.0/alias/README.md

@@ -0,0 +1,5 @@
+# iirds-sdk
+
+An alias of [`iirds`](https://pypi.org/project/iirds/) — install that.
+Both names are held in stewardship for the iiRDS ecosystem and will be
+transferred to the iiRDS Consortium on request.

iirds-0.1.0/alias/pyproject.toml

@@ -0,0 +1,19 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "iirds-sdk"
+version = "0.1.0"
+description = "Alias of the `iirds` package. Install `iirds`; this name is held under the same stewardship pledge."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "Apache-2.0" }
+authors = [{ name = "Wooyong Lee", email = "zero8004paz@gmail.com" }]
+dependencies = ["iirds==0.1.0"]
+
+[project.urls]
+Homepage = "https://github.com/dev365code/iirds"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/iirds_sdk"]

iirds-0.1.0/alias/src/iirds_sdk/__init__.py

@@ -0,0 +1,5 @@
+"""Alias package: everything lives in `iirds`. This exists so both obvious
+names resolve to the same, real library — and both travel under the same
+pledge: transferred to the iiRDS Consortium on request."""
+from iirds import *  # noqa: F401,F403
+from iirds import __version__  # noqa: F401

iirds-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "iirds"
+version = "0.1.0"
+description = "Read and write iiRDS packages. The seed of a community SDK, held in stewardship for the iiRDS ecosystem."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "Apache-2.0" }
+authors = [{ name = "Wooyong Lee", email = "zero8004paz@gmail.com" }]
+keywords = ["iirds", "technical-documentation", "rdf", "intelligent-information"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Libraries",
+]
+dependencies = ["rdflib>=6"]
+
+[project.urls]
+Homepage = "https://github.com/dev365code/iirds"
+Validator = "https://github.com/dev365code/iirds-validate"
+
+[project.optional-dependencies]
+dev = ["pytest", "ruff"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/iirds"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "C4", "SIM"]
+ignore = [
+    "UP006", "UP007", "UP035", "UP045",  # py39 target: keep typing.List / Optional
+    "UP031",                    # %-formatting matches the sibling repo's voice
+    "B905",                     # zip(strict=) is 3.10+
+    "E501",                     # long lines are the formatter's business
+]

iirds-0.1.0/src/iirds/__init__.py

@@ -0,0 +1,23 @@
+"""Read and write iiRDS packages.
+
+This is deliberately a small library: open a package, get its metadata as an
+RDF graph, read its files, and write a conformant container back. It does not
+validate — that is `iirds-validate`'s job, and keeping the two apart keeps
+this one dependency-light (rdflib and the standard library, nothing else).
+
+Held in stewardship: the `iirds` name on PyPI belongs to the standard's
+community more than to any one project. Should the iiRDS Consortium want the
+name for an official SDK, it will be transferred on request. Until then it
+does real work rather than squatting.
+
+The API is 0.x: it will grow, and what is published here is intended not to
+break. `open()` returns a `Package`; `pack()` writes one.
+"""
+from __future__ import annotations
+
+from ._pack import PackError, pack
+from ._package import IirdsError, Package
+from ._package import open_package as open  # noqa: A001 - deliberate, like gzip.open
+
+__version__ = "0.1.0"
+__all__ = ["IirdsError", "PackError", "Package", "open", "pack", "__version__"]

iirds-0.1.0/src/iirds/_pack.py

@@ -0,0 +1,100 @@
+"""Writing a conformant container.
+
+Ported from iirds-validate's packer (same author, Apache-2.0), because the
+container rules people get wrong most — mimetype first and stored, stable
+bytes — belong in the SDK layer that every tool shares. iirds-validate will
+import from here as its own next release; until then the two copies are
+byte-for-byte siblings and this header is the note that says so.
+"""
+from __future__ import annotations
+
+import os
+import time
+import zipfile
+from pathlib import Path
+from typing import List, Optional
+
+from ._package import METADATA_RDF
+
+MIMETYPE_FILE = "mimetype"
+MIMETYPE_VALUE = "application/iirds+zip"
+
+#: A fixed timestamp for every entry, so packing the same directory twice
+#: produces the same bytes. Override with SOURCE_DATE_EPOCH if a build
+#: system wants its own.
+FIXED_TIMESTAMP = (1980, 1, 1, 0, 0, 0)
+
+
+def _timestamp():
+    epoch = os.environ.get("SOURCE_DATE_EPOCH")
+    if not epoch:
+        return FIXED_TIMESTAMP
+    try:
+        return time.gmtime(int(epoch))[:6]
+    except (ValueError, OSError):
+        return FIXED_TIMESTAMP
+
+
+#: Compressing these again wastes time and space for no gain.
+ALREADY_COMPRESSED = (".png", ".jpg", ".jpeg", ".gif", ".webp", ".mp4", ".m4v",
+                      ".mp3", ".zip", ".iirds", ".woff", ".woff2")
+
+
+class PackError(Exception):
+    """The directory is not something that can be packed into a container."""
+
+
+def _entries(source: Path) -> List[Path]:
+    files = sorted(p for p in source.rglob("*") if p.is_file())
+    mimetype = source / MIMETYPE_FILE
+    rest = [p for p in files if p != mimetype]
+    return ([mimetype] if mimetype.exists() else []) + rest
+
+
+def pack(source, output=None, *, overwrite: bool = False) -> Path:
+    """Write `source` as a conformant .iirds archive and return its path.
+
+    The mimetype file is created if missing — a directory with
+    META-INF/metadata.rdf is plainly meant to be a package.
+    """
+    source = Path(source)
+    if not source.is_dir():
+        raise PackError("not a directory: %s" % source)
+    if not (source / METADATA_RDF).exists():
+        raise PackError("%s has no %s, so it is not an iiRDS container"
+                        % (source, METADATA_RDF))
+
+    output = Path(output) if output else source.with_suffix(".iirds")
+    if output.suffix.lower() != ".iirds":
+        output = output.with_suffix(".iirds")
+    if output.exists() and not overwrite:
+        raise PackError("%s exists; pass overwrite=True to replace it" % output)
+    output.parent.mkdir(parents=True, exist_ok=True)
+
+    mimetype_content: Optional[bytes] = None
+    if (source / MIMETYPE_FILE).exists():
+        mimetype_content = (source / MIMETYPE_FILE).read_bytes()
+        if mimetype_content != MIMETYPE_VALUE.encode("ascii"):
+            raise PackError("%s does not contain %r; fix it rather than have this "
+                            "overwrite it" % (MIMETYPE_FILE, MIMETYPE_VALUE))
+
+    stamp = _timestamp()
+    with zipfile.ZipFile(output, "w", zipfile.ZIP_DEFLATED) as archive:
+        # First entry, stored uncompressed — the rule every other tool gets
+        # wrong, and it has to happen before anything else is written.
+        info = zipfile.ZipInfo(MIMETYPE_FILE, date_time=stamp)
+        info.compress_type = zipfile.ZIP_STORED
+        archive.writestr(info, mimetype_content or MIMETYPE_VALUE.encode("ascii"))
+
+        for path in _entries(source):
+            name = path.relative_to(source).as_posix()
+            if name == MIMETYPE_FILE:
+                continue
+            info = zipfile.ZipInfo(name, date_time=stamp)
+            info.compress_type = (zipfile.ZIP_STORED
+                                  if name.lower().endswith(ALREADY_COMPRESSED)
+                                  else zipfile.ZIP_DEFLATED)
+            info.external_attr = 0o644 << 16
+            archive.writestr(info, path.read_bytes())
+
+    return output

iirds-0.1.0/src/iirds/_package.py

@@ -0,0 +1,98 @@
+"""Reading an iiRDS container."""
+from __future__ import annotations
+
+import zipfile
+from pathlib import Path
+from typing import List, Optional
+
+from rdflib import Graph, Namespace
+
+#: Where the metadata lives; the one path iiRDS fixes.
+METADATA_RDF = "META-INF/metadata.rdf"
+
+#: The base IRI this ecosystem's tools agree on for rdf:about="" — the same
+#: convention iirds-validate and its published SHACL shapes document.
+PACKAGE_BASE = "urn:iirds:package:"
+
+IIRDS = Namespace("http://iirds.tekom.de/iirds#")
+
+
+class IirdsError(Exception):
+    """The file is not something this library can read as an iiRDS package."""
+
+
+class Package:
+    """An opened iiRDS container. Use as a context manager, like ZipFile.
+
+    Reading is lazy: the ZIP directory is read on open, the metadata graph
+    only when `.graph` is first touched.
+    """
+
+    def __init__(self, path):
+        self.path = Path(path)
+        try:
+            self._zip = zipfile.ZipFile(self.path)
+        except (OSError, zipfile.BadZipFile) as exc:
+            raise IirdsError("cannot open %s as a ZIP container: %s" % (self.path, exc)) from exc
+        if METADATA_RDF not in self._zip.namelist():
+            self._zip.close()
+            raise IirdsError("%s has no %s, so it is not an iiRDS package"
+                             % (self.path, METADATA_RDF))
+        self._graph: Optional[Graph] = None
+
+    # -- files ---------------------------------------------------------------
+    def names(self) -> List[str]:
+        """Every entry in the container, in archive order."""
+        return self._zip.namelist()
+
+    def read(self, name: str) -> bytes:
+        return self._zip.read(name)
+
+    # -- metadata ------------------------------------------------------------
+    @property
+    def graph(self) -> Graph:
+        """META-INF/metadata.rdf as an rdflib Graph, parsed against the
+        `urn:iirds:package:` base so rdf:about="" resolves the way the
+        ecosystem's validators and shapes expect."""
+        if self._graph is None:
+            graph = Graph()
+            graph.parse(data=self.read(METADATA_RDF), format="xml", publicID=PACKAGE_BASE)
+            self._graph = graph
+        return self._graph
+
+    @property
+    def version(self) -> Optional[str]:
+        """The declared iiRDSVersion, stripped, or None if the package omits
+        it. No judgement about whether it is a published version — that is
+        validation, which lives in iirds-validate."""
+        for _s, value in self.graph.subject_objects(IIRDS.iiRDSVersion):
+            return str(value).strip()
+        return None
+
+    @property
+    def variant(self) -> str:
+        """"A", "H", or "unrestricted" — from iirds:formatRestriction, with an
+        absent or blank value meaning unrestricted, as the standard reads."""
+        for _s, value in self.graph.subject_objects(IIRDS.formatRestriction):
+            text = str(value).strip()
+            if text:
+                return text
+        return "unrestricted"
+
+    # -- lifecycle -----------------------------------------------------------
+    def close(self) -> None:
+        self._zip.close()
+
+    def __enter__(self) -> Package:
+        return self
+
+    def __exit__(self, *exc) -> None:
+        self.close()
+
+    def __repr__(self) -> str:
+        return "Package(%r)" % str(self.path)
+
+
+def open_package(path) -> Package:
+    """Open an .iirds container for reading."""
+    return Package(path)

iirds-0.1.0/tests/test_roundtrip.py

@@ -0,0 +1,68 @@
+"""The SDK's one promise: what pack() writes, open() reads, faithfully."""
+import zipfile
+
+import pytest
+
+import iirds
+
+MINIMAL_RDF = """<?xml version="1.0" encoding="utf-8"?>
+<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+         xmlns:iirds="http://iirds.tekom.de/iirds#">
+  <iirds:Package rdf:about="urn:test:package">
+    <iirds:iiRDSVersion> 1.3 </iirds:iiRDSVersion>
+    <iirds:title>SDK fixture</iirds:title>
+  </iirds:Package>
+</rdf:RDF>
+"""
+
+
+@pytest.fixture
+def source(tmp_path):
+    root = tmp_path / "pkg"
+    (root / "META-INF").mkdir(parents=True)
+    (root / "META-INF" / "metadata.rdf").write_text(MINIMAL_RDF, "utf-8")
+    (root / "content").mkdir()
+    (root / "content" / "topic1.xhtml").write_text("<html/>", "utf-8")
+    return root
+
+
+def test_pack_then_open_round_trips(source):
+    packed = iirds.pack(source)
+    with iirds.open(packed) as pkg:
+        assert pkg.version == "1.3"          # stripped, as consumers compare it
+        assert pkg.variant == "unrestricted"
+        assert "content/topic1.xhtml" in pkg.names()
+        assert pkg.read("content/topic1.xhtml") == b"<html/>"
+        assert len(pkg.graph) >= 2
+
+
+def test_mimetype_is_first_and_stored(source):
+    packed = iirds.pack(source)
+    with zipfile.ZipFile(packed) as archive:
+        first = archive.infolist()[0]
+        assert first.filename == "mimetype"
+        assert first.compress_type == zipfile.ZIP_STORED
+        assert archive.read("mimetype") == b"application/iirds+zip"
+
+
+def test_packing_twice_produces_identical_bytes(source, tmp_path):
+    one = iirds.pack(source, tmp_path / "a.iirds")
+    two = iirds.pack(source, tmp_path / "b.iirds")
+    assert one.read_bytes() == two.read_bytes()
+
+
+def test_a_zip_without_metadata_is_refused(tmp_path):
+    plain = tmp_path / "plain.zip"
+    with zipfile.ZipFile(plain, "w") as archive:
+        archive.writestr("hello.txt", "hi")
+    with pytest.raises(iirds.IirdsError):
+        iirds.open(plain)
+
+
+def test_variant_reads_h(source):
+    meta = source / "META-INF" / "metadata.rdf"
+    meta.write_text(MINIMAL_RDF.replace(
+        "</iirds:Package>",
+        "  <iirds:formatRestriction>H</iirds:formatRestriction>\n  </iirds:Package>"), "utf-8")
+    with iirds.open(iirds.pack(source, overwrite=True)) as pkg:
+        assert pkg.variant == "H"