ois-tools 0.6.0__tar.gz

ois_tools-0.6.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 [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ois_tools-0.6.0/PKG-INFO

@@ -0,0 +1,306 @@
+Metadata-Version: 2.4
+Name: ois-tools
+Version: 0.6.0
+Summary: Reference tools for the Open Intent Schema (OIS): validate, record and attest what was required, built and proven
+Keywords: ois,open-intent-schema,requirements,traceability,evidence,in-toto,junit,coverage
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Dist: jsonschema[format-nongpl]>=4.26.0
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: rfc8785>=0.1.4
+Requires-Python: >=3.13
+Project-URL: Repository, https://github.com/openintentschema/tools
+Project-URL: Documentation, https://github.com/openintentschema/tools/tree/main/docs
+Project-URL: Changelog, https://github.com/openintentschema/tools/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/openintentschema/tools/issues
+Project-URL: Specification, https://github.com/openintentschema/openintentschema
+Description-Content-Type: text/markdown
+
+# ois-tools
+
+[![PyPI](https://img.shields.io/pypi/v/ois-tools)](https://pypi.org/project/ois-tools/)
+[![Checks](https://github.com/openintentschema/tools/actions/workflows/checks.yml/badge.svg)](https://github.com/openintentschema/tools/actions/workflows/checks.yml)
+
+Reference tools for the [Open Intent Schema (OIS)](https://github.com/openintentschema/openintentschema),
+the open data standard that links what was required to what was built and to the evidence in
+between. One command, `ois`, records that evidence along the delivery lifecycle and checks it:
+
+| Phase | What is recorded | Command |
+| --- | --- | --- |
+| Requirement | intent with acceptance criteria, its approval | `ois intent` |
+| Design | design approval | `ois record decision --gate design-approval` |
+| Implementation | code artifact, the context an agent was given | `ois record artifact` |
+| Test | evidence per criterion | `ois junit`, `ois record evidence` |
+| Merge | merge decision | `ois record decision --gate merge` |
+| Release | build, release decision, passport with intent coverage | `ois record`, `ois passport` |
+| Operation | findings, their classification and resolution | `ois record finding`, `ois record supersede` |
+| Review by others | check a passport and recompute its coverage | `ois validate`, `ois coverage` |
+
+The tools record and check; they do not enforce. Whether a merge or a release is blocked, for
+example below a coverage threshold or with an open critical finding, is the policy of the
+project's pipeline, which reads the commands' exit codes and figures.
+
+`ois validate` checks OIS records, bundles and Quality Passports and reports every problem with
+its rule and level (specification section 11.1):
+
+- **violation:** a MUST is broken; the input does not conform.
+- **warning:** R8, R12 and R13 ask for a report; the input still conforms.
+- **info:** a SHOULD is not followed.
+
+**Status:** pre-alpha, targets specification v0.1. `ois validate` checks Appendix B and every rule
+of section 5 that can be checked from the records at hand (R1–R5, R8–R17) and passes all
+conformance fixtures. Signatures are not verified yet, so R12 reports every recorded context as
+self-declared. Up to version 0.5.0 the package was called `ois-validator`, with one command per
+tool (`ois-validator`, `ois-junit`, …).
+
+## Install
+
+```bash
+uvx --from ois-tools ois validate bundle.json    # run without installing
+pip install ois-tools                            # or install; Python 3.13 or later
+ois --help                                       # the commands
+```
+
+The commands work for projects in any language: they read JSON, YAML, JUnit XML and the local
+Git checkout, not the code. Without Python, use [uv](https://docs.astral.sh/uv/) alone (`uvx`
+fetches a Python on first use) or the container image, which holds `ois` and git:
+
+```bash
+docker run --rm --network none -v "$PWD:/work" --user "$(id -u):$(id -g)" \
+  ghcr.io/openintentschema/ois-tools validate bundle.json
+```
+
+- The image runs `ois`; its arguments follow the image name.
+- `-v "$PWD:/work"` mounts the current directory; paths are relative to it.
+- `--user` writes files as you rather than as the image's user.
+- `--network none` is optional and shows that no command needs the network.
+- In a CI job that uses the image as its image, override the entrypoint (GitLab:
+  `entrypoint: [""]`) and call `ois` in the script.
+- Tags: `0.6.0`, `0.6` and `latest`. Each image carries a signed build provenance and an SBOM:
+  `gh attestation verify oci://ghcr.io/openintentschema/ois-tools:0.6.0 --owner openintentschema`.
+
+## Validate
+
+```bash
+ois validate bundle.json passport.json
+ois validate --format json finding.json
+cat bundle.json | ois validate -
+```
+
+Each file holds one JSON document: a single record, a bundle, or a passport as an in-toto
+Statement v1. Exit code 0 means every file conforms, 1 means at least one violation, 2 means a
+file could not be read. Reports point at the field concerned:
+
+```
+same-producer.json: violation [R5] $.records[12].derivedFrom: test and subject are both produced by https://ois.acme.example/actors/dev-agent
+```
+
+With `--format json`:
+
+```json
+[
+  {
+    "file": "same-producer.json",
+    "conforms": false,
+    "reports": [
+      {
+        "level": "violation",
+        "rule": "R5",
+        "message": "test and subject are both produced by https://ois.acme.example/actors/dev-agent",
+        "path": "$.records[12].derivedFrom"
+      }
+    ]
+  }
+]
+```
+
+From Python:
+
+```python
+from ois_tools import validate
+
+result = validate(document)  # a parsed JSON document
+result.conforms  # False if any report is a violation
+result.reports  # list of Report(level, rule, message, path)
+```
+
+## Record test results from JUnit XML
+
+`ois junit` turns the JUnit XML that almost every test framework writes into a bundle, as the
+Level 1 quick start in specification section 11.4 describes. Run it in the Git checkout the
+tests ran in:
+
+```bash
+ois junit build/test-results/*.xml \
+  --namespace https://ois.acme.example \
+  --suite "Team Billing" \
+  --run "$CI_PIPELINE_URL" \
+  --output ois-bundle.json
+```
+
+| Option | Meaning |
+| --- | --- |
+| `--namespace` | URI under your organization's domain; every record id starts with it. Never requested. |
+| `--suite` | Team or suite that owns the tests; names the test suite actor. |
+| `--repo` | Git working tree the tests ran in (default `.`). |
+| `--location` | Artifact location (default `git+<origin>@<HEAD>`, credentials removed). |
+| `--run` | URI of the pipeline run, linked from every evidence record. |
+| `--output` | Write the bundle to a file instead of standard output. |
+
+The bundle holds an actor for the adapter and one for the test suite, a characterization intent
+in draft with one criterion per test case, an artifact per test file (pinned by `sha256` and
+`gitCommit`) and an evidence record per result with `derivedFrom: unknown`. `ois junit`
+validates the bundle before writing it: exit code 0 writes it, 1 means it would not conform and
+nothing is written, 2 means a report or the Git checkout could not be read.
+
+The [getting started guide](https://openintentschema.io/getting-started/)
+walks through it step by step, including a CI example.
+
+## Write and approve intents
+
+`ois intent` takes an intent written in YAML or JSON and does what is error-prone by hand:
+
+```bash
+ois intent seal INT-142.ois.yaml                      # criterion and intent digests (RFC 8785)
+ois intent approve INT-142.ois.yaml --by https://ois.acme.example/actors/po-7f3a
+ois intent next .ois/intents/INT-142-v1.ois.json      # draft of version 2, superseding version 1
+ois intent compare .ois/intents/INT-142-v1.ois.json .ois/intents/INT-142-v2.ois.yaml
+```
+
+- `approve` writes the approved intent and its intent-approval decision, bound by the intent's
+  digest (R1), to `.ois/intents/` and `.ois/decisions/` (specification section 7). It refuses an
+  approved intent whose content no longer matches its digest: approved intents never change.
+- `compare` shows per criterion whether evidence carries over to the new version or is stale
+  (section 6.3); `criticality` does not count.
+- YAML is read as section 7 requires: `2026-10-14T09:12:00Z` and `yes` stay strings, and tags,
+  merge keys and non-string or duplicate keys are refused, so that digests do not depend on how
+  a YAML library reads the text.
+
+## Record artifacts, actors, evidence, decisions and findings
+
+`ois record` writes every other record type, one record per command, to `.ois/<type>s/`. It
+computes what is error-prone by hand, validates the record and prints the reference other records
+use for it, so a pipeline can pass it on:
+
+```bash
+export OIS_NAMESPACE=https://ois.acme.example              # for derived ids, or --namespace
+
+CI=$(ois record actor --kind tool --name "CI build" --version 7)
+DEV=$(ois record actor --kind agent --name "Dev Agent" --version 2.1 --model acme-ai:coder:2026-09)
+CODE=$(ois record artifact src/invoice.py --kind code --produced-by "$DEV")
+BUILD=$(ois record artifact dist/billing-2026.10.4-py3-none-any.whl --kind build \
+  --location pkg:pypi/billing@2026.10.4 --produced-by "$CI" --input "$CODE")
+ois record decision --gate merge --subject "$CODE" --outcome passed --by "$CI"
+```
+
+| Command | Writes | Computed for you |
+| --- | --- | --- |
+| `actor` | a human, agent or tool | id from the name; the reference `<id>@<version>` |
+| `artifact FILE` | an artifact of any kind | `sha256`; for a committed file also `gitCommit`, location `git+<origin>@<HEAD>` and path |
+| `artifact --commit REPO` | the repository at `HEAD` | `gitCommit` and location |
+| `artifact --digest ALG:HEX` | an artifact with a known digest, such as an image | id from name and digest |
+| `evidence` | one result of one test for one criterion | id; measures from `--measure responseTimeP95=420ms` |
+| `decision` | a gate outcome | `subjectDigest` from the subject among the records (R1, R16) |
+| `finding` | a defect or incident | id |
+| `supersede FILE` | the next record of a finding chain | id (`FND-18-r2`), `supersedes`, the unchanged fields |
+| `bundle INPUT...` | a self-contained bundle, to stdout or `--output` | each record once, validated |
+
+- **Records never change.** Recording the same thing again prints its reference and keeps the
+  file; a different record under an existing id is refused (R10). A changed actor needs a new
+  `--version`.
+- **Files are located in Git.** A file must be committed and unchanged unless `--location` names
+  where it lives, for example a Package URL for a build.
+- **Rules are checked where the records allow it.** `decision` checks subject and outcome of the
+  well-known gates (specification section 4.6) and, for `finding-resolution`, that the deciding
+  actor took no part in the resolution (R14). `supersede` refuses a second successor (R14).
+  `decision` and `supersede` look up references in the output directory and in `--records`.
+- Exit code 0 writes the record, 1 means it would break a rule and nothing is written, 2 means a
+  file could not be read or an argument is malformed.
+
+## Build a Quality Passport
+
+`ois passport` collects the records behind a release into an in-toto Statement with the OIS
+passport predicate (specification section 8) and validates it before writing:
+
+```bash
+ois passport build .ois/ ci-bundles/ \
+  --release-name billing --release-version 2026.10.4 \
+  --build "$BUILD" \
+  --issuer https://ois.acme.example/actors/passport-issuer@1 \
+  --approve-release-by https://ois.acme.example/actors/release-manager-1d2e \
+  --output passport.json
+```
+
+- Inputs are record or bundle files, or directories such as `.ois/`, in JSON or YAML. Identical
+  records are merged, a draft gives way to its approved record, and two different records with the
+  same id are refused (R10).
+- The passport lists the latest approved version of each intent unless `--intent` names them, and
+  embeds every input record. Its subject is the build artifact with its digest.
+- `--approve-release-by` adds the release decision for the build when the records carry none
+  (R16). Exit code 1 means the passport would break a rule and nothing was written; warnings such as
+  R12 are printed and the passport is written.
+- The passport reports intent coverage by the reference method of Appendix D in `assessments`
+  (below); `--no-coverage` leaves it out.
+- The passport is not signed yet; DSSE signing follows.
+
+## Measure intent coverage
+
+Intent coverage is the share of criteria in scope with counted evidence: passed, derived from the
+intent, for the released build or one of its inputs, not revoked, observed after its subject was
+created and, for a criterion with a target, meeting it (Appendix D). `ois coverage` shows per
+criterion what counts and why other evidence does not:
+
+```bash
+ois coverage passport.json                        # also checks the coverage the passport declares
+ois coverage .ois/ --build "$BUILD"               # before the passport: what is still missing
+```
+
+```
+https://ois.acme.example/intents/INT-142@1#AC-1  not covered
+    https://ois.acme.example/evidence/EV-9022: derivedFrom is unknown
+https://ois.acme.example/intents/INT-142@1#AC-2  covered  https://ois.acme.example/evidence/EV-9021
+intentCoverage 0.5 (declared 0.5)
+```
+
+| Measurement | Counts |
+| --- | --- |
+| `intentCoverage` | covered criteria in scope / criteria in scope |
+| `intentCoverageAttested` | only evidence whose test context is attested (R12); 0 until signatures are verified |
+| `intentCoverageWeighted` | criteria weighted by `criticality`: high 3, medium 2, low 1 |
+| `intentCoverageDiverse` | only evidence whose test and subject come from a human, or from agents on different models |
+
+A passport that lists several intents counts the criteria in scope of all of them together.
+Exit code 1 means a declared value differs from the computed one, compared at the precision the
+passport declares; 2 means a file could not be read or the release subject is missing.
+
+## Privacy
+
+None of the commands opens a network connection: the JSON Schema ships inside the package, and `ois junit` and
+`ois record` read local files and the local Git checkout only. Installing the package contacts
+PyPI, pulling the container image contacts GitHub (ghcr.io), and `uvx` without a local Python
+downloads one from GitHub. Details and a diagram:
+[Privacy and data flows](https://openintentschema.io/privacy/).
+
+## Documentation
+
+- [Specification, schema and conformance fixtures](https://github.com/openintentschema/openintentschema)
+- [Getting started](https://openintentschema.io/getting-started/): first OIS bundle from JUnit XML
+- [Architecture](docs/architecture.md): how the commands are built, and why
+- [Development](docs/development.md): setup, checks, specification sync, adding a rule, releases
+- [Changelog](CHANGELOG.md)
+
+## Contributing
+
+What `ois validate` accepts is decided in the specification repository; bug fixes, tooling and
+documentation are welcome here. See [CONTRIBUTING.md](.github/CONTRIBUTING.md) and the
+[Code of Conduct](.github/CODE_OF_CONDUCT.md). Security issues: [SECURITY.md](.github/SECURITY.md).
+
+## License
+
+Apache-2.0.