throughline 0.1.0__tar.gz

throughline-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 Time Back Solutions Limited
+
+   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.

throughline-0.1.0/NOTICE

@@ -0,0 +1,12 @@
+throughline
+Copyright 2026 Time Back Solutions Limited
+
+This product includes software developed by Time Back Solutions Limited.
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file for the
+full terms.
+
+throughline is a clean-room implementation. Its design draws on the public
+documentation of prior-art requirements tools (notably Doorstop and StrictDoc);
+no third-party source code was copied. See PROVENANCE.md for the full prior-art
+and ownership record.

throughline-0.1.0/PKG-INFO

@@ -0,0 +1,268 @@
+Metadata-Version: 2.4
+Name: throughline
+Version: 0.1.0
+Summary: A Git-native requirements management tool with a scope-avalanche grounding layer: permanent UIDs, one file per item, typed links, suspect detection, and a CI-gating check.
+Author: Time Back Solutions Limited
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/rhodium-org/throughline
+Project-URL: Repository, https://github.com/rhodium-org/throughline
+Project-URL: Issues, https://github.com/rhodium-org/throughline/issues
+Keywords: requirements,requirements-management,traceability,grounding,git-native,idd,intent-driven-development
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Dynamic: license-file
+
+# throughline
+
+[![ci](https://github.com/rhodium-org/throughline/actions/workflows/ci.yml/badge.svg)](https://github.com/rhodium-org/throughline/actions/workflows/ci.yml)
+
+A **Git-native requirements management tool** with a built-in **scope-avalanche
+grounding layer**. Requirements live as one small YAML file per item under
+version control; a `check` command validates the whole graph and gates CI.
+
+Two ideas, one system:
+
+1. **throughline core** — permanent, position-independent UIDs (never renumbered,
+   never reused; deletion is a tombstone), one file per item, typed directed
+   links, SHA-256 *normative* fingerprints that turn a real content change into a
+   **suspect** link, and a `check` CLI with stable exit codes.
+2. **grounding layer** — every non-root item must justify itself by reaching a
+   *root* ("why"); AI/scout-generated items enter `proposed` and must be
+   **ratified** by a human; assumptions are first-class and invalidating one
+   cascades **suspect** across its blast radius. Unbounded generation yields a
+   bounded, ranked review queue instead of silent sprawl.
+
+The build contract is the throughline spec in
+[`docs/referenced-resource/`](docs/referenced-resource) (docs 04 system
+requirements, 06 data format, 07 architecture).
+
+> **New here?** [`HOW_TO_USE.md`](HOW_TO_USE.md) is a fifteen-minute hands-on
+> quick start: scaffold a project, add three linked requirements, watch the
+> validator reject an ungrounded graph, fix it, and trace a requirement back to
+> its reason for existing. Curious how the workflow relates to test-first
+> practice? [`HOW_IDD_DIFFERS_FROM_BDD.md`](HOW_IDD_DIFFERS_FROM_BDD.md) explains
+> Intent-Driven Development and why it is the *why* axis to BDD's *what*.
+
+---
+
+## Install
+
+throughline is pure Python (one dependency, `pyyaml`) and needs **Python >= 3.11**
+(for the stdlib `tomllib`). The same steps work on **Linux, macOS, and Windows** —
+only how you obtain Python and put scripts on `PATH` differs.
+
+**Recommended — [`pipx`](https://pipx.pypa.io)** (installs the CLI in its own
+isolated environment):
+
+```
+pipx install "git+https://github.com/rhodium-org/throughline.git"
+```
+
+> A PyPI release (`pipx install throughline`) is planned but not yet published —
+> until then, install from Git as above.
+
+Per-OS notes:
+
+- **Linux** — system Python is often "externally managed" (PEP 668); don't
+  `pip install` into it. Use `pipx` (`sudo apt install pipx` / `pacman -S python-pipx`)
+  or a virtual environment.
+- **macOS** — `brew install python pipx && pipx ensurepath`, then install as above.
+- **Windows** — install Python 3.12 from python.org or `winget install Python.Python.3.12`
+  (tick *Add to PATH*), then `python -m pip install --user pipx && pipx ensurepath`.
+  Both `tl.exe` and `throughline.exe` are generated.
+
+Either way you get `tl` (and the long form `throughline`) on your `PATH`. For a
+local checkout you can develop against, see [`CONTRIBUTING.md`](CONTRIBUTING.md).
+
+Or run it containerised, no local Python at all:
+
+```
+docker build -t throughline .
+docker run --rm -v "$PWD/my-project:/work" throughline -C /work check --strict
+```
+
+---
+
+## The format
+
+A project is a directory: `throughline.toml` (config) + per-document folders, each
+with a `.document.yml` manifest and one `<UID>.yml` per item.
+
+```yaml
+uid: FR-0022                 # permanent, immutable, never reused
+type: requirement
+status: approved
+title: Guided setup wizard
+text: The system shall walk new users through a 3-step setup.
+normative: true
+links:
+  - target: BN-0003          # this requirement derives from a business need
+    type: derives_from
+  - target: ASM-0002         # …and depends on an assumption's validity
+    type: assumes
+    stamp: sha256:…          # target fingerprint when last confirmed (suspect tracking)
+```
+
+**Roots** (`intent`, `business_need`, `risk`, `constraint`, `assumption`) may
+exist ungrounded — they are the roots of "why". Everything else must reach a root
+through a grounding link (`derives_from`, `mitigates`, `implements`, `verifies`),
+which together form a DAG — circular justification is rejected.
+
+---
+
+## CLI
+
+```
+tl init [--name NAME]                         # scaffold a project
+tl doc new <PREFIX> <dir> [--parent P]        # add a document
+tl new <PREFIX> [--uid U] [--type T] [--ground UID]  # allocate + create (grounded at birth)
+tl link <SRC> <DST> --type <kind> [--stamp]   # add a typed link
+throughline delete <UID> --reason "…"                  # tombstone (never erased)
+throughline review [<UID> | --all-clean]               # mark reviewed at current content
+tl check [--strict] [--format json]           # validate the graph — the CI gate
+tl trace <UID> [--direction in|out] [--depth N]
+tl blast <UID> [--format json]                # everything depending on an item
+tl shape [--format json]                      # observed (from)-[link]->(to) triples
+tl diagram [types|transitions|both]           # Mermaid of the model / lifecycle
+tl docs [--doc PREFIX] [--at REF]             # render a Markdown requirements document
+tl context                                    # agent-facing brief (IDD + this project's model)
+tl ratify <UID> --by <who>                    # a human takes accountability
+throughline invalidate <UID> --reason "…"              # falsify; cascade suspect
+throughline scout <report.json>                         # ingest scout proposals
+```
+
+Exit codes are a stable contract: **0** ok · **1** findings at error severity ·
+**2** usage/internal error. So `tl check` drops straight into a pre-commit hook
+or CI gate — an ungrounded, unserved, or otherwise invalid graph fails the build.
+
+### What `check` enforces
+
+Upward and downward coverage are independent and both matter:
+
+| Rule | Meaning |
+|------|---------|
+| `orphan` | a non-root item with no grounding chain to a root |
+| `unserved-root` | a delivery root nobody derives from / mitigates |
+| `grounding-cycle` | circular justification |
+| `dangling-link` / `deleted-link-target` | link to a missing/tombstoned item |
+| `uid-grammar` / `uid-collision` | malformed UID, or one UID in two places (merge) |
+| `schema` | missing required attr or out-of-enum value |
+| `suspect-link` | target changed since the link was last confirmed |
+| `unreviewed` | item content changed since last review |
+| `unratified` | AI/scout-origin item still `proposed` |
+| `ambiguous` | flagged ambiguous — blocked from ratification |
+| `coverage` | a declared `[[rules.coverage]]` link requirement is unmet |
+
+Every rule's severity is configurable per project under `[rules]`; `--strict`
+promotes every warning to an error for CI.
+
+---
+
+## Try it
+
+The [`examples/grounding-demo/`](examples/grounding-demo) project is a small, fully
+grounded graph (intents, a business need, a risk, a constraint, an assumption,
+requirements, an NFR, and verifying tests):
+
+```
+tl -C examples/grounding-demo check --strict     # green, exit 0
+tl -C examples/grounding-demo trace FR-0055      # walk its justification tree
+tl -C examples/grounding-demo blast ASM-0002     # what a bad assumption would take down
+```
+
+---
+
+## Self-hosting — throughline's own requirements
+
+throughline manages its own spec. The [`requirements/`](requirements) project is
+throughline's vision, goals, user requirements, system requirements, and NFRs seeded
+as throughline items, with the full grounding chain wired up
+(`SR/NFR --implements--> UR --derives_from--> goal --derives_from--> vision`):
+
+```
+tl -C requirements check --strict     # green, exit 0 — the tool gates its own scope
+tl -C requirements trace SR-0001      # walk a system requirement up to the vision
+```
+
+This is the discipline the tool exists to provide, applied to the tool itself: a
+new system requirement that doesn't justify itself against a user requirement —
+or a user requirement that doesn't derive from a goal — fails the build. Both the
+demo and the self-host graph are gated in CI and by the pre-commit hook.
+
+---
+
+## Grounding operations
+
+- **ratify** — a human takes accountability. Refused for ambiguous or ungrounded
+  items: the two states that must never be signed off.
+- **invalidate** — falsify an assumption (or any node): it is rejected and every
+  transitive dependent is marked `suspect` (its blast radius).
+- **scout ingest** — scout *proposes*, humans *ratify*. Proposed roots enter as
+  `origin: scout, status: proposed`; ambiguities set `attrs.ambiguous` and block
+  ratification; coverage gaps corroborate the structural `unserved-root` finding.
+
+```json
+{
+  "proposed_roots": [{"id": "BN-0009", "type": "business_need", "title": "…", "rationale": "…"}],
+  "ambiguities":    [{"id": "FR-0055", "reason": "'fast' is unquantified"}],
+  "coverage_gaps":  [{"root": "CON-0002", "detail": "no requirement implements it"}]
+}
+```
+
+---
+
+## Testing & gates
+
+```
+pytest -q                                    # model, UID, fingerprint, validate, grounding
+tl -C examples/grounding-demo check --strict   # the demo graph gate (exit 1 = broken)
+tl -C requirements check --strict              # throughline's own requirements (self-host gate)
+```
+
+- [`.pre-commit-config.yaml`](.pre-commit-config.yaml) runs the gate on commits
+  touching either project (demo and self-host). Enable with `pre-commit install`.
+- [`.github/workflows/ci.yml`](.github/workflows/ci.yml) runs the tests, both
+  grounding gates, and a Docker build + image smoke-test on push/PR.
+
+---
+
+## What this is
+
+**M0 — Core**: UID model, one-file-per-item storage, typed links,
+fingerprints/suspect, the validation pipeline, the grounding layer, and the
+`tl` CLI. **Not included**: baselines/diff, HTML/PDF publish, and CSV/ReqIF
+import-export. Assumption items carry provenance attributes (`attrs.owner` /
+`attrs.last_validated` / `attrs.confidence`) alongside their content.
+
+throughline is **early software (alpha)** and unfinished by design — see
+[`ROADMAP.md`](ROADMAP.md) for what's built, what's next, and where help is most
+useful.
+
+---
+
+## Contributing
+
+Contributions are welcome. [`CONTRIBUTING.md`](CONTRIBUTING.md) gets you to a
+checked development environment; [`ROADMAP.md`](ROADMAP.md) lists good first work;
+all participation is under the [`Code of Conduct`](CODE_OF_CONDUCT.md). To report a
+vulnerability, see [`SECURITY.md`](SECURITY.md).
+
+## License
+
+Copyright © 2026 Time Back Solutions Limited. Released under the
+**Apache License 2.0** — see [`LICENSE`](LICENSE) and [`NOTICE`](NOTICE). Provenance
+and prior-art are recorded in [`PROVENANCE.md`](PROVENANCE.md).