reqthread 0.2.0__tar.gz

reqthread-0.2.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.

reqthread-0.2.0/MANIFEST.in

@@ -0,0 +1,6 @@
+graft docs
+graft examples
+graft standards
+graft tests
+prune examples/wb55-ref/build
+global-exclude __pycache__ *.py[cod]

reqthread-0.2.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: reqthread
+Version: 0.2.0
+Summary: Requirements traceability and certification evidence for safety-critical embedded software.
+Author: James Watson
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/eggheadengineer/reqthread
+Project-URL: Documentation, https://github.com/eggheadengineer/reqthread/blob/main/docs/FORMATS.md
+Project-URL: Issues, https://github.com/eggheadengineer/reqthread/issues
+Keywords: traceability,functional safety,IEC 61508,embedded,requirements,certification,evidence,zephyr
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6
+Requires-Dist: jsonschema>=4.10
+Dynamic: license-file
+
+# reqthread
+
+> The golden thread from requirement to evidence.
+
+Traceability and certification evidence for safety-critical embedded software. It reads what your repo
+already has — requirements as files, `@satisfies` / `@verifies` annotations in code and tests, and the
+JUnit, coverage, and SARIF output your CI already produces — and builds a hashed evidence bundle, checks
+it against gate rules, and writes a standalone HTML report.
+
+It fails your pipeline when a requirement loses its test, a test verifying a safety requirement fails or
+never runs, code traces to nothing, or a static-analysis finding is open. With a baseline, it fails only
+on **new** gaps, so a team with existing gaps can adopt it today.
+
+Standard-agnostic by design: integrity levels, test levels, tool classes, and package sections come from
+a **standard-data file you load from your own licensed copy**. The tool ships no standard text. A
+structure-only IEC 61508-3 skeleton is in `standards/`.
+
+## Install
+
+```
+pip install git+https://github.com/eggheadengineer/reqthread
+```
+
+Python 3.10 or later. Two dependencies: PyYAML and jsonschema. A PyPI release (`pip install reqthread`) is coming.
+
+## Quick start
+
+```
+git clone https://github.com/eggheadengineer/reqthread && cd reqthread
+pip install .
+reqthread check -c examples/wb55-ref/reqthread.yaml --html report.html
+```
+
+`examples/wb55-ref/` is a real reference project — a black-channel heartbeat receiver in C, tested from
+pytest, with real gcov coverage and real flawfinder SARIF. It has three genuine gaps; the report shows them.
+
+## Annotate code and tests
+
+```c
+/* @satisfies SSR-001
+ * @implements DD-TIMEOUT */
+bool hb_supervise(hb_state_t *s, uint32_t now_ms) { … }
+```
+
+```python
+def test_trip_after_300ms(lib):
+    """@verifies SSR-001"""
+```
+
+A tag applies to the function it is inside, or the function directly below it. A block containing
+`@file` applies to the whole file. Anything ambiguous is an **error**, never a guess. Zephyr `ZTEST`,
+GoogleTest `TEST`, Unity `test_*`, and pytest tests are recognised.
+
+## Commands
+
+| Command | Does | Exit |
+| --- | --- | --- |
+| `reqthread check` | build, evaluate gates, optionally ratchet with `--baseline`; write `-o` bundle, `--html`, `--json` | 0 pass · 1 error · 2 gaps |
+| `reqthread build` | build and write a bundle (`--previous` chains hashes) | 0 · 1 |
+| `reqthread report` | render HTML from a bundle | 0 · 1 |
+| `reqthread hazards` | hazard analysis on its own: validate hazard and cause files, print the hazard matrix | 0 · 1 · 2 gaps |
+| `reqthread validate` | validate standard data, requirement files, or a hand-written bundle | 0 · 1 |
+
+## Gate rules
+
+1. Every software safety requirement has a verifying test at each declared test level.
+2. Every software safety requirement derives from a system-level requirement.
+3. Every code unit traces to a requirement or design element, or is marked `@infrastructure` with a reason.
+4. Every test verifying a safety requirement **passed** at baseline and failed nowhere — skipped or never-run doesn't count.
+7. Every static-analysis finding is fixed or covered by an unexpired, approved deviation.
+11. Every hazard is mitigated by at least one requirement, directly or through one of its causes.
+12. Every cause (STPA unsafe control action or FMEA failure mode) is mitigated by a requirement, or its residual risk is formally accepted.
+13. Every requirement that mitigates a hazard is a safety requirement with an integrity level.
+
+## Hazard analysis
+
+Hazards and causes live in the repo as files too, so the trace runs from hazard to cause to requirement to test to CI result. In the reference project, HAZ-001 (machine keeps moving after a stop command) traces through three unsafe control actions to SSR-001..003, and a fourth cause, a stuck-high output driver, has no mitigating requirement. The hazard analysis found a gap the requirements never knew about.
+
+```
+reqthread hazards --hazards hazards/ --causes causes/ --requirements requirements/
+```
+
+That command needs no project config, standard data, or CI output, so a safety engineer can start with hazard analysis alone and add the rest later.
+
+## CI
+
+- **GitHub:** `ci/github/action.yml` (composite action)
+
+  ```yaml
+  permissions: { contents: read, actions: read }   # actions: read lets PR runs fetch the baseline
+  jobs:
+    traceability:
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v7
+        - uses: eggheadengineer/reqthread/ci/github@main   # pin a release tag once v0.1.0 is out
+          with:
+            config: reqthread.yaml
+  ```
+- **GitLab:** `templates/reqthread.yml` (CI/CD component)
+
+Both record the default branch's bundle as the baseline and fail merge requests only on new gaps.
+The GitHub Action has been exercised end to end on GitHub-hosted runners; the GitLab component has not run yet.
+
+## Docs
+
+- `docs/FORMATS.md` — file formats, annotations, bundle model
+- `docs/EVIDENCE_PACKAGE_SPEC.md` — what an IEC 61508-3 assessor expects, and what this automates
+
+## Tests
+
+```
+PYTHONPATH=src python3 -m unittest discover -s tests
+```
+
+## License
+
+Apache-2.0. See `LICENSE`.

reqthread-0.2.0/README.md

@@ -0,0 +1,118 @@
+# reqthread
+
+> The golden thread from requirement to evidence.
+
+Traceability and certification evidence for safety-critical embedded software. It reads what your repo
+already has — requirements as files, `@satisfies` / `@verifies` annotations in code and tests, and the
+JUnit, coverage, and SARIF output your CI already produces — and builds a hashed evidence bundle, checks
+it against gate rules, and writes a standalone HTML report.
+
+It fails your pipeline when a requirement loses its test, a test verifying a safety requirement fails or
+never runs, code traces to nothing, or a static-analysis finding is open. With a baseline, it fails only
+on **new** gaps, so a team with existing gaps can adopt it today.
+
+Standard-agnostic by design: integrity levels, test levels, tool classes, and package sections come from
+a **standard-data file you load from your own licensed copy**. The tool ships no standard text. A
+structure-only IEC 61508-3 skeleton is in `standards/`.
+
+## Install
+
+```
+pip install git+https://github.com/eggheadengineer/reqthread
+```
+
+Python 3.10 or later. Two dependencies: PyYAML and jsonschema. A PyPI release (`pip install reqthread`) is coming.
+
+## Quick start
+
+```
+git clone https://github.com/eggheadengineer/reqthread && cd reqthread
+pip install .
+reqthread check -c examples/wb55-ref/reqthread.yaml --html report.html
+```
+
+`examples/wb55-ref/` is a real reference project — a black-channel heartbeat receiver in C, tested from
+pytest, with real gcov coverage and real flawfinder SARIF. It has three genuine gaps; the report shows them.
+
+## Annotate code and tests
+
+```c
+/* @satisfies SSR-001
+ * @implements DD-TIMEOUT */
+bool hb_supervise(hb_state_t *s, uint32_t now_ms) { … }
+```
+
+```python
+def test_trip_after_300ms(lib):
+    """@verifies SSR-001"""
+```
+
+A tag applies to the function it is inside, or the function directly below it. A block containing
+`@file` applies to the whole file. Anything ambiguous is an **error**, never a guess. Zephyr `ZTEST`,
+GoogleTest `TEST`, Unity `test_*`, and pytest tests are recognised.
+
+## Commands
+
+| Command | Does | Exit |
+| --- | --- | --- |
+| `reqthread check` | build, evaluate gates, optionally ratchet with `--baseline`; write `-o` bundle, `--html`, `--json` | 0 pass · 1 error · 2 gaps |
+| `reqthread build` | build and write a bundle (`--previous` chains hashes) | 0 · 1 |
+| `reqthread report` | render HTML from a bundle | 0 · 1 |
+| `reqthread hazards` | hazard analysis on its own: validate hazard and cause files, print the hazard matrix | 0 · 1 · 2 gaps |
+| `reqthread validate` | validate standard data, requirement files, or a hand-written bundle | 0 · 1 |
+
+## Gate rules
+
+1. Every software safety requirement has a verifying test at each declared test level.
+2. Every software safety requirement derives from a system-level requirement.
+3. Every code unit traces to a requirement or design element, or is marked `@infrastructure` with a reason.
+4. Every test verifying a safety requirement **passed** at baseline and failed nowhere — skipped or never-run doesn't count.
+7. Every static-analysis finding is fixed or covered by an unexpired, approved deviation.
+11. Every hazard is mitigated by at least one requirement, directly or through one of its causes.
+12. Every cause (STPA unsafe control action or FMEA failure mode) is mitigated by a requirement, or its residual risk is formally accepted.
+13. Every requirement that mitigates a hazard is a safety requirement with an integrity level.
+
+## Hazard analysis
+
+Hazards and causes live in the repo as files too, so the trace runs from hazard to cause to requirement to test to CI result. In the reference project, HAZ-001 (machine keeps moving after a stop command) traces through three unsafe control actions to SSR-001..003, and a fourth cause, a stuck-high output driver, has no mitigating requirement. The hazard analysis found a gap the requirements never knew about.
+
+```
+reqthread hazards --hazards hazards/ --causes causes/ --requirements requirements/
+```
+
+That command needs no project config, standard data, or CI output, so a safety engineer can start with hazard analysis alone and add the rest later.
+
+## CI
+
+- **GitHub:** `ci/github/action.yml` (composite action)
+
+  ```yaml
+  permissions: { contents: read, actions: read }   # actions: read lets PR runs fetch the baseline
+  jobs:
+    traceability:
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v7
+        - uses: eggheadengineer/reqthread/ci/github@main   # pin a release tag once v0.1.0 is out
+          with:
+            config: reqthread.yaml
+  ```
+- **GitLab:** `templates/reqthread.yml` (CI/CD component)
+
+Both record the default branch's bundle as the baseline and fail merge requests only on new gaps.
+The GitHub Action has been exercised end to end on GitHub-hosted runners; the GitLab component has not run yet.
+
+## Docs
+
+- `docs/FORMATS.md` — file formats, annotations, bundle model
+- `docs/EVIDENCE_PACKAGE_SPEC.md` — what an IEC 61508-3 assessor expects, and what this automates
+
+## Tests
+
+```
+PYTHONPATH=src python3 -m unittest discover -s tests
+```
+
+## License
+
+Apache-2.0. See `LICENSE`.