throughline-compose 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- throughline_compose-0.1.0/LICENSE +201 -0
- throughline_compose-0.1.0/NOTICE +12 -0
- throughline_compose-0.1.0/PKG-INFO +147 -0
- throughline_compose-0.1.0/README.md +119 -0
- throughline_compose-0.1.0/pyproject.toml +52 -0
- throughline_compose-0.1.0/setup.cfg +4 -0
- throughline_compose-0.1.0/src/throughline_compose/__init__.py +15 -0
- throughline_compose-0.1.0/src/throughline_compose/cli.py +173 -0
- throughline_compose-0.1.0/src/throughline_compose/resolve.py +120 -0
- throughline_compose-0.1.0/src/throughline_compose/resolver.py +83 -0
- throughline_compose-0.1.0/src/throughline_compose/sources.py +108 -0
- throughline_compose-0.1.0/src/throughline_compose/union.py +185 -0
- throughline_compose-0.1.0/src/throughline_compose.egg-info/PKG-INFO +147 -0
- throughline_compose-0.1.0/src/throughline_compose.egg-info/SOURCES.txt +19 -0
- throughline_compose-0.1.0/src/throughline_compose.egg-info/dependency_links.txt +1 -0
- throughline_compose-0.1.0/src/throughline_compose.egg-info/entry_points.txt +2 -0
- throughline_compose-0.1.0/src/throughline_compose.egg-info/requires.txt +4 -0
- throughline_compose-0.1.0/src/throughline_compose.egg-info/top_level.txt +1 -0
- throughline_compose-0.1.0/tests/test_cli.py +145 -0
- throughline_compose-0.1.0/tests/test_resolve.py +80 -0
- throughline_compose-0.1.0/tests/test_union.py +165 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Time Back Solutions Limited
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
throughline-compose
|
|
2
|
+
Copyright 2026 Time Back Solutions Limited
|
|
3
|
+
|
|
4
|
+
This product includes software developed by Time Back Solutions Limited.
|
|
5
|
+
|
|
6
|
+
Licensed under the Apache License, Version 2.0. See the LICENSE file for the
|
|
7
|
+
full terms.
|
|
8
|
+
|
|
9
|
+
throughline-compose builds on throughline (https://pypi.org/project/throughline/),
|
|
10
|
+
which it consumes as an unmodified library. It adds source composition — namespace
|
|
11
|
+
declaration, pinning, fetching, and union merging — over that library and reuses
|
|
12
|
+
throughline's validator without forking it.
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: throughline-compose
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Compose one requirements graph from many reusable throughline sources: importer-assigned namespaces, source-native UIDs, and a union checked by throughline's own validator. Ships the tl-compose CLI, a strict superset of tl.
|
|
5
|
+
Author: Time Back Solutions Limited
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/rhodium-org/throughline-compose
|
|
8
|
+
Project-URL: Repository, https://github.com/rhodium-org/throughline-compose
|
|
9
|
+
Project-URL: Issues, https://github.com/rhodium-org/throughline-compose/issues
|
|
10
|
+
Keywords: requirements,requirements-management,traceability,composition,git-native,idd,intent-driven-development,throughline
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Environment :: Console
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Topic :: Software Development :: Documentation
|
|
19
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
20
|
+
Requires-Python: >=3.11
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
License-File: NOTICE
|
|
24
|
+
Requires-Dist: throughline>=0.5.0
|
|
25
|
+
Provides-Extra: dev
|
|
26
|
+
Requires-Dist: pytest>=8.0; extra == "dev"
|
|
27
|
+
Dynamic: license-file
|
|
28
|
+
|
|
29
|
+
# throughline-compose
|
|
30
|
+
|
|
31
|
+
**Compose one requirements graph from many reusable
|
|
32
|
+
[throughline](https://github.com/rhodium-org/throughline) sources** — a house style
|
|
33
|
+
guide, a platform standard, a regulatory baseline — alongside the requirements you
|
|
34
|
+
write yourself, and work the combined graph as one.
|
|
35
|
+
|
|
36
|
+
This repository is itself a throughline project: its own design is captured as a
|
|
37
|
+
grounded IDD spine of
|
|
38
|
+
<!-- tl:count type == 'user_requirement' -->
|
|
39
|
+
3
|
|
40
|
+
<!-- tl:end --> user requirements and
|
|
41
|
+
<!-- tl:count type == 'system_requirement' -->
|
|
42
|
+
7
|
|
43
|
+
<!-- tl:end --> system requirements under [`vision/`](vision), [`goals/`](goals),
|
|
44
|
+
[`user-requirements/`](user-requirements),
|
|
45
|
+
[`system-requirements/`](system-requirements), and [`non-goals/`](non-goals), and
|
|
46
|
+
published to [`docs/spec.md`](docs/spec.md). The graph is gated by `tl-compose check
|
|
47
|
+
--strict` and the document by `tl-compose docs --check`; these two counts are
|
|
48
|
+
rendered from the live spine by the `tl:count` directive, so they cannot drift.
|
|
49
|
+
|
|
50
|
+
> **Status: alpha.** The composition engine is built. `tl-compose check` composes the
|
|
51
|
+
> declared `[[sources]]` into a union graph and validates it, and `tl-compose docs`
|
|
52
|
+
> renders the published document over that same union, resolving borrowed
|
|
53
|
+
> (`namespace:UID`) targets ([SR-0007](system-requirements/SR-0007.yml)). Each source
|
|
54
|
+
> resolves from either a local `path` or a pinned git `url` + `ref` into a per-user
|
|
55
|
+
> cache ([SR-0006](system-requirements/SR-0006.yml)). Still pending: the
|
|
56
|
+
> `tl-compose source add/update/pin` subcommands for managing source declarations from
|
|
57
|
+
> the CLI (today you edit the `[[sources]]` tables by hand).
|
|
58
|
+
|
|
59
|
+
## The idea
|
|
60
|
+
|
|
61
|
+
A team should be able to adopt standard requirement sets *by reference*, not by
|
|
62
|
+
copy-paste, and receive upstream revisions without ever forking. Two identity rules
|
|
63
|
+
make that safe:
|
|
64
|
+
|
|
65
|
+
- **Imported items keep their source-native UID** ([SR-0002](system-requirements/SR-0002.yml)).
|
|
66
|
+
Composition never renumbers or copies. Canonical identity is the pair
|
|
67
|
+
`(source-namespace, UID)`, so the same `SR-0001` may legitimately exist in two
|
|
68
|
+
sources without collision — the immutable-UID rule is never violated.
|
|
69
|
+
- **The composer controls the namespaces** ([SR-0001](system-requirements/SR-0001.yml)).
|
|
70
|
+
The consumer's own `throughline.toml` binds each source to a short name it chooses
|
|
71
|
+
(`import X as Y`). A qualified reference like `gds:SR-0001` denotes a borrowed item;
|
|
72
|
+
a bare UID is always local. Renaming a namespace is a local-only change with a
|
|
73
|
+
bounded blast radius.
|
|
74
|
+
|
|
75
|
+
## Declaring sources
|
|
76
|
+
|
|
77
|
+
A consumer names the sources it composes in an array of `[[sources]]` tables in its
|
|
78
|
+
own `throughline.toml`. Each entry binds a `namespace` to one source, located either
|
|
79
|
+
by a pinned git `url` or by a local `path` ([SR-0006](system-requirements/SR-0006.yml)):
|
|
80
|
+
|
|
81
|
+
```toml
|
|
82
|
+
# Adopt a published standard by reference, pinned to an edition.
|
|
83
|
+
[[sources]]
|
|
84
|
+
namespace = "asvs"
|
|
85
|
+
url = "https://github.com/rhodium-org/standard-asvs"
|
|
86
|
+
ref = "v4.0.3" # a git tag (normal form), branch, or commit SHA
|
|
87
|
+
|
|
88
|
+
# Develop a source and its consumer side by side.
|
|
89
|
+
[[sources]]
|
|
90
|
+
namespace = "house-style"
|
|
91
|
+
path = "../house-style" # a directory relative to this project
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
- **`url` + `ref` is the durable, shareable form.** The `ref` pins the exact edition
|
|
95
|
+
— normally a release tag, but any git ref (branch or commit SHA) works. `tl-compose`
|
|
96
|
+
fetches the source from its origin on first use into a per-user cache that lives
|
|
97
|
+
*outside* any project tree (`$TL_COMPOSE_CACHE`, else `$XDG_CACHE_HOME`, else
|
|
98
|
+
`~/.cache/throughline-compose/sources/`), keyed by `(url, ref)`. Resolution is
|
|
99
|
+
idempotent and offline thereafter: a source already cached at the pinned ref is
|
|
100
|
+
reused, never refetched. Nothing is vendored into your repo, so your own item scan
|
|
101
|
+
never ingests a borrowed graph.
|
|
102
|
+
- **`path` is for local development.** A directory, relative to the consumer, for
|
|
103
|
+
working on a source alongside the project that consumes it.
|
|
104
|
+
- **The two are mutually exclusive, and a `url` must carry a `ref`.** Declaring both
|
|
105
|
+
`path` and `url`, or a `url` with no `ref`, is rejected at check time — a dependency
|
|
106
|
+
can never silently track a moving default. (A `ref` alongside a `path` is likewise
|
|
107
|
+
rejected: a ref only pins a `url`.)
|
|
108
|
+
|
|
109
|
+
Moving to a new upstream edition is a one-line change to the `ref`; the borrowed graph
|
|
110
|
+
is never edited. See [`rhodium-org/idd-example`](https://github.com/rhodium-org/idd-example)
|
|
111
|
+
for a complete worked consumer that adopts `standard-asvs` this way.
|
|
112
|
+
|
|
113
|
+
## One tool, one set of guarantees
|
|
114
|
+
|
|
115
|
+
In a composed project you drive everything through **`tl-compose`**, never `tl`
|
|
116
|
+
directly ([UR-0002](user-requirements/UR-0002.yml)). The architecture keeps that
|
|
117
|
+
honest:
|
|
118
|
+
|
|
119
|
+
- **`tl-compose` is a strict superset of `tl`** ([SR-0003](system-requirements/SR-0003.yml)).
|
|
120
|
+
Local-graph commands are forwarded to the throughline library unchanged; the
|
|
121
|
+
union-aware `check` and `docs` are overridden to compose, validate, and render the
|
|
122
|
+
combined graph. (The `source` subcommands for editing declarations are the remaining
|
|
123
|
+
superset surface — see the status note above.) The core command set is obtained
|
|
124
|
+
programmatically, so the two surfaces cannot drift apart.
|
|
125
|
+
- **Composition reuses throughline unchanged** ([SR-0004](system-requirements/SR-0004.yml)).
|
|
126
|
+
It merges the sources into one in-memory `Project` and runs throughline's existing
|
|
127
|
+
`validate`, `Index`, and `fingerprint` over that union — no second validation
|
|
128
|
+
engine. A composed graph is exactly as sound as a native one.
|
|
129
|
+
- **Bare `tl check` fails fast on unresolved cross-source refs**
|
|
130
|
+
([SR-0005](system-requirements/SR-0005.yml)). If you run core `tl` in a composed
|
|
131
|
+
repo by habit, a namespace-qualified reference it cannot resolve makes it stop and
|
|
132
|
+
point you at `tl-compose` — never a false clean result. Free external references (a
|
|
133
|
+
URL, a linked standard) stay opaque, as intended.
|
|
134
|
+
|
|
135
|
+
Composition deliberately lives here, not in the throughline core
|
|
136
|
+
([NG-0001](non-goals/NG-0001.yml)) — the core stays a single-purpose, offline tool
|
|
137
|
+
over one graph, consumed here as a library.
|
|
138
|
+
|
|
139
|
+
## Working here
|
|
140
|
+
|
|
141
|
+
```sh
|
|
142
|
+
pip install . # pulls throughline transitively; installs tl and tl-compose
|
|
143
|
+
tl-compose context # agent brief, generated from throughline.toml
|
|
144
|
+
tl-compose check --strict # gate the whole graph
|
|
145
|
+
tl-compose docs --check # gate published-document freshness
|
|
146
|
+
tl-compose docs # regenerate docs/spec.md from the graph
|
|
147
|
+
```
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# throughline-compose
|
|
2
|
+
|
|
3
|
+
**Compose one requirements graph from many reusable
|
|
4
|
+
[throughline](https://github.com/rhodium-org/throughline) sources** — a house style
|
|
5
|
+
guide, a platform standard, a regulatory baseline — alongside the requirements you
|
|
6
|
+
write yourself, and work the combined graph as one.
|
|
7
|
+
|
|
8
|
+
This repository is itself a throughline project: its own design is captured as a
|
|
9
|
+
grounded IDD spine of
|
|
10
|
+
<!-- tl:count type == 'user_requirement' -->
|
|
11
|
+
3
|
|
12
|
+
<!-- tl:end --> user requirements and
|
|
13
|
+
<!-- tl:count type == 'system_requirement' -->
|
|
14
|
+
7
|
|
15
|
+
<!-- tl:end --> system requirements under [`vision/`](vision), [`goals/`](goals),
|
|
16
|
+
[`user-requirements/`](user-requirements),
|
|
17
|
+
[`system-requirements/`](system-requirements), and [`non-goals/`](non-goals), and
|
|
18
|
+
published to [`docs/spec.md`](docs/spec.md). The graph is gated by `tl-compose check
|
|
19
|
+
--strict` and the document by `tl-compose docs --check`; these two counts are
|
|
20
|
+
rendered from the live spine by the `tl:count` directive, so they cannot drift.
|
|
21
|
+
|
|
22
|
+
> **Status: alpha.** The composition engine is built. `tl-compose check` composes the
|
|
23
|
+
> declared `[[sources]]` into a union graph and validates it, and `tl-compose docs`
|
|
24
|
+
> renders the published document over that same union, resolving borrowed
|
|
25
|
+
> (`namespace:UID`) targets ([SR-0007](system-requirements/SR-0007.yml)). Each source
|
|
26
|
+
> resolves from either a local `path` or a pinned git `url` + `ref` into a per-user
|
|
27
|
+
> cache ([SR-0006](system-requirements/SR-0006.yml)). Still pending: the
|
|
28
|
+
> `tl-compose source add/update/pin` subcommands for managing source declarations from
|
|
29
|
+
> the CLI (today you edit the `[[sources]]` tables by hand).
|
|
30
|
+
|
|
31
|
+
## The idea
|
|
32
|
+
|
|
33
|
+
A team should be able to adopt standard requirement sets *by reference*, not by
|
|
34
|
+
copy-paste, and receive upstream revisions without ever forking. Two identity rules
|
|
35
|
+
make that safe:
|
|
36
|
+
|
|
37
|
+
- **Imported items keep their source-native UID** ([SR-0002](system-requirements/SR-0002.yml)).
|
|
38
|
+
Composition never renumbers or copies. Canonical identity is the pair
|
|
39
|
+
`(source-namespace, UID)`, so the same `SR-0001` may legitimately exist in two
|
|
40
|
+
sources without collision — the immutable-UID rule is never violated.
|
|
41
|
+
- **The composer controls the namespaces** ([SR-0001](system-requirements/SR-0001.yml)).
|
|
42
|
+
The consumer's own `throughline.toml` binds each source to a short name it chooses
|
|
43
|
+
(`import X as Y`). A qualified reference like `gds:SR-0001` denotes a borrowed item;
|
|
44
|
+
a bare UID is always local. Renaming a namespace is a local-only change with a
|
|
45
|
+
bounded blast radius.
|
|
46
|
+
|
|
47
|
+
## Declaring sources
|
|
48
|
+
|
|
49
|
+
A consumer names the sources it composes in an array of `[[sources]]` tables in its
|
|
50
|
+
own `throughline.toml`. Each entry binds a `namespace` to one source, located either
|
|
51
|
+
by a pinned git `url` or by a local `path` ([SR-0006](system-requirements/SR-0006.yml)):
|
|
52
|
+
|
|
53
|
+
```toml
|
|
54
|
+
# Adopt a published standard by reference, pinned to an edition.
|
|
55
|
+
[[sources]]
|
|
56
|
+
namespace = "asvs"
|
|
57
|
+
url = "https://github.com/rhodium-org/standard-asvs"
|
|
58
|
+
ref = "v4.0.3" # a git tag (normal form), branch, or commit SHA
|
|
59
|
+
|
|
60
|
+
# Develop a source and its consumer side by side.
|
|
61
|
+
[[sources]]
|
|
62
|
+
namespace = "house-style"
|
|
63
|
+
path = "../house-style" # a directory relative to this project
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
- **`url` + `ref` is the durable, shareable form.** The `ref` pins the exact edition
|
|
67
|
+
— normally a release tag, but any git ref (branch or commit SHA) works. `tl-compose`
|
|
68
|
+
fetches the source from its origin on first use into a per-user cache that lives
|
|
69
|
+
*outside* any project tree (`$TL_COMPOSE_CACHE`, else `$XDG_CACHE_HOME`, else
|
|
70
|
+
`~/.cache/throughline-compose/sources/`), keyed by `(url, ref)`. Resolution is
|
|
71
|
+
idempotent and offline thereafter: a source already cached at the pinned ref is
|
|
72
|
+
reused, never refetched. Nothing is vendored into your repo, so your own item scan
|
|
73
|
+
never ingests a borrowed graph.
|
|
74
|
+
- **`path` is for local development.** A directory, relative to the consumer, for
|
|
75
|
+
working on a source alongside the project that consumes it.
|
|
76
|
+
- **The two are mutually exclusive, and a `url` must carry a `ref`.** Declaring both
|
|
77
|
+
`path` and `url`, or a `url` with no `ref`, is rejected at check time — a dependency
|
|
78
|
+
can never silently track a moving default. (A `ref` alongside a `path` is likewise
|
|
79
|
+
rejected: a ref only pins a `url`.)
|
|
80
|
+
|
|
81
|
+
Moving to a new upstream edition is a one-line change to the `ref`; the borrowed graph
|
|
82
|
+
is never edited. See [`rhodium-org/idd-example`](https://github.com/rhodium-org/idd-example)
|
|
83
|
+
for a complete worked consumer that adopts `standard-asvs` this way.
|
|
84
|
+
|
|
85
|
+
## One tool, one set of guarantees
|
|
86
|
+
|
|
87
|
+
In a composed project you drive everything through **`tl-compose`**, never `tl`
|
|
88
|
+
directly ([UR-0002](user-requirements/UR-0002.yml)). The architecture keeps that
|
|
89
|
+
honest:
|
|
90
|
+
|
|
91
|
+
- **`tl-compose` is a strict superset of `tl`** ([SR-0003](system-requirements/SR-0003.yml)).
|
|
92
|
+
Local-graph commands are forwarded to the throughline library unchanged; the
|
|
93
|
+
union-aware `check` and `docs` are overridden to compose, validate, and render the
|
|
94
|
+
combined graph. (The `source` subcommands for editing declarations are the remaining
|
|
95
|
+
superset surface — see the status note above.) The core command set is obtained
|
|
96
|
+
programmatically, so the two surfaces cannot drift apart.
|
|
97
|
+
- **Composition reuses throughline unchanged** ([SR-0004](system-requirements/SR-0004.yml)).
|
|
98
|
+
It merges the sources into one in-memory `Project` and runs throughline's existing
|
|
99
|
+
`validate`, `Index`, and `fingerprint` over that union — no second validation
|
|
100
|
+
engine. A composed graph is exactly as sound as a native one.
|
|
101
|
+
- **Bare `tl check` fails fast on unresolved cross-source refs**
|
|
102
|
+
([SR-0005](system-requirements/SR-0005.yml)). If you run core `tl` in a composed
|
|
103
|
+
repo by habit, a namespace-qualified reference it cannot resolve makes it stop and
|
|
104
|
+
point you at `tl-compose` — never a false clean result. Free external references (a
|
|
105
|
+
URL, a linked standard) stay opaque, as intended.
|
|
106
|
+
|
|
107
|
+
Composition deliberately lives here, not in the throughline core
|
|
108
|
+
([NG-0001](non-goals/NG-0001.yml)) — the core stays a single-purpose, offline tool
|
|
109
|
+
over one graph, consumed here as a library.
|
|
110
|
+
|
|
111
|
+
## Working here
|
|
112
|
+
|
|
113
|
+
```sh
|
|
114
|
+
pip install . # pulls throughline transitively; installs tl and tl-compose
|
|
115
|
+
tl-compose context # agent brief, generated from throughline.toml
|
|
116
|
+
tl-compose check --strict # gate the whole graph
|
|
117
|
+
tl-compose docs --check # gate published-document freshness
|
|
118
|
+
tl-compose docs # regenerate docs/spec.md from the graph
|
|
119
|
+
```
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "throughline-compose"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Compose one requirements graph from many reusable throughline sources: importer-assigned namespaces, source-native UIDs, and a union checked by throughline's own validator. Ships the tl-compose CLI, a strict superset of tl."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.11"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
license-files = ["LICENSE", "NOTICE"]
|
|
13
|
+
authors = [{ name = "Time Back Solutions Limited" }]
|
|
14
|
+
keywords = [
|
|
15
|
+
"requirements",
|
|
16
|
+
"requirements-management",
|
|
17
|
+
"traceability",
|
|
18
|
+
"composition",
|
|
19
|
+
"git-native",
|
|
20
|
+
"idd",
|
|
21
|
+
"intent-driven-development",
|
|
22
|
+
"throughline",
|
|
23
|
+
]
|
|
24
|
+
classifiers = [
|
|
25
|
+
"Development Status :: 3 - Alpha",
|
|
26
|
+
"Environment :: Console",
|
|
27
|
+
"Intended Audience :: Developers",
|
|
28
|
+
"Operating System :: OS Independent",
|
|
29
|
+
"Programming Language :: Python :: 3",
|
|
30
|
+
"Programming Language :: Python :: 3.11",
|
|
31
|
+
"Programming Language :: Python :: 3.12",
|
|
32
|
+
"Topic :: Software Development :: Documentation",
|
|
33
|
+
"Topic :: Software Development :: Quality Assurance",
|
|
34
|
+
]
|
|
35
|
+
dependencies = ["throughline>=0.5.0"] # is_external / is_namespace_qualified public since 0.4.0 (SR-0004); tl:count badge needs 0.5.0 (SR-0109)
|
|
36
|
+
|
|
37
|
+
[project.optional-dependencies]
|
|
38
|
+
dev = ["pytest>=8.0"]
|
|
39
|
+
|
|
40
|
+
[project.urls]
|
|
41
|
+
Homepage = "https://github.com/rhodium-org/throughline-compose"
|
|
42
|
+
Repository = "https://github.com/rhodium-org/throughline-compose"
|
|
43
|
+
Issues = "https://github.com/rhodium-org/throughline-compose/issues"
|
|
44
|
+
|
|
45
|
+
[project.scripts]
|
|
46
|
+
tl-compose = "throughline_compose.cli:main"
|
|
47
|
+
|
|
48
|
+
[tool.setuptools.packages.find]
|
|
49
|
+
where = ["src"]
|
|
50
|
+
|
|
51
|
+
[tool.pytest.ini_options]
|
|
52
|
+
testpaths = ["tests"]
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Copyright (c) 2026 Time Back Solutions Limited
|
|
2
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
"""throughline-compose — compose one requirements graph from many reusable sources.
|
|
4
|
+
|
|
5
|
+
Builds on ``throughline`` as an unmodified library (SR-0004): it prepares a union
|
|
6
|
+
``Project`` from the declared sources and runs throughline's own ``validate``,
|
|
7
|
+
``Index``, and ``fingerprint`` over it. The ``tl-compose`` CLI is a strict superset
|
|
8
|
+
of ``tl`` (SR-0003) — it forwards local commands to throughline unchanged and
|
|
9
|
+
overrides only the union-aware ones.
|
|
10
|
+
"""
|
|
11
|
+
from __future__ import annotations
|
|
12
|
+
|
|
13
|
+
__version__ = "0.0.1"
|
|
14
|
+
|
|
15
|
+
__all__ = ["__version__"]
|