throughline-transform 0.2.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_transform-0.2.0/LICENSE +201 -0
- throughline_transform-0.2.0/MANIFEST.in +4 -0
- throughline_transform-0.2.0/NOTICE +12 -0
- throughline_transform-0.2.0/PKG-INFO +121 -0
- throughline_transform-0.2.0/README.md +92 -0
- throughline_transform-0.2.0/pyproject.toml +62 -0
- throughline_transform-0.2.0/setup.cfg +4 -0
- throughline_transform-0.2.0/src/throughline_transform/__init__.py +13 -0
- throughline_transform-0.2.0/src/throughline_transform/blocks.py +183 -0
- throughline_transform-0.2.0/src/throughline_transform/cli.py +173 -0
- throughline_transform-0.2.0/src/throughline_transform/html.py +157 -0
- throughline_transform-0.2.0/src/throughline_transform/markdown.py +82 -0
- throughline_transform-0.2.0/src/throughline_transform/model.py +171 -0
- throughline_transform-0.2.0/src/throughline_transform/notes.py +215 -0
- throughline_transform-0.2.0/src/throughline_transform/office.py +334 -0
- throughline_transform-0.2.0/src/throughline_transform/package.py +70 -0
- throughline_transform-0.2.0/src/throughline_transform/project.py +147 -0
- throughline_transform-0.2.0/src/throughline_transform/provenance.py +117 -0
- throughline_transform-0.2.0/src/throughline_transform/shape.py +32 -0
- throughline_transform-0.2.0/src/throughline_transform/tables.py +165 -0
- throughline_transform-0.2.0/src/throughline_transform.egg-info/PKG-INFO +121 -0
- throughline_transform-0.2.0/src/throughline_transform.egg-info/SOURCES.txt +27 -0
- throughline_transform-0.2.0/src/throughline_transform.egg-info/dependency_links.txt +1 -0
- throughline_transform-0.2.0/src/throughline_transform.egg-info/entry_points.txt +3 -0
- throughline_transform-0.2.0/src/throughline_transform.egg-info/requires.txt +5 -0
- throughline_transform-0.2.0/src/throughline_transform.egg-info/top_level.txt +1 -0
- throughline_transform-0.2.0/tests/conftest.py +144 -0
- throughline_transform-0.2.0/tests/test_outputs.py +365 -0
- throughline_transform-0.2.0/tests/test_surface.py +135 -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 The throughline-ratify authors
|
|
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-transform
|
|
2
|
+
Copyright 2026 Henry J Grech-Cini
|
|
3
|
+
Created by Dr Henry J Grech-Cini (ORCID https://orcid.org/0009-0007-1565-7530).
|
|
4
|
+
|
|
5
|
+
This product includes software developed by Henry J Grech-Cini.
|
|
6
|
+
|
|
7
|
+
Licensed under the Apache License, Version 2.0. See the LICENSE file for the
|
|
8
|
+
full terms.
|
|
9
|
+
|
|
10
|
+
throughline-transform is a full-screen terminal companion for
|
|
11
|
+
throughline (the `tl` CLI) and throughline-compose (`tl-compose`). It builds
|
|
12
|
+
on their public Python APIs; no third-party source code was copied.
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: throughline-transform
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: Turn a throughline requirements graph on disk, committed or not, into the forms its readers open: Markdown, a folder of Obsidian notes, CSV, an Excel workbook, a Word document, or a print-ready HTML document. Ships the tl-transform CLI.
|
|
5
|
+
Author-email: Henry J Grech-Cini <henry.grechcini@gmail.com>
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/rhodium-org/throughline-transform
|
|
8
|
+
Project-URL: Repository, https://github.com/rhodium-org/throughline-transform
|
|
9
|
+
Project-URL: Issues, https://github.com/rhodium-org/throughline-transform/issues
|
|
10
|
+
Keywords: requirements,requirements-management,export,obsidian,docx,xlsx,markdown,traceability,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 :: Office/Business
|
|
20
|
+
Requires-Python: >=3.11
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
License-File: NOTICE
|
|
24
|
+
Requires-Dist: throughline-compose>=0.16.1
|
|
25
|
+
Requires-Dist: throughline>=2.2.0
|
|
26
|
+
Provides-Extra: dev
|
|
27
|
+
Requires-Dist: pytest>=8.0; extra == "dev"
|
|
28
|
+
Dynamic: license-file
|
|
29
|
+
|
|
30
|
+
# throughline-transform
|
|
31
|
+
|
|
32
|
+
A [throughline](https://github.com/rhodium-org/throughline) requirements graph on
|
|
33
|
+
disk — committed or not — in the forms its readers open. One command, one file:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
pipx install throughline-transform # pulls tl and tl-compose along too
|
|
37
|
+
|
|
38
|
+
tl-transform md -C idd # Markdown, written by the tool itself
|
|
39
|
+
tl-transform notes -C idd # a folder of notes for Obsidian (zip)
|
|
40
|
+
tl-transform notes -C idd --folder # …or the folder itself, ready to open as a vault
|
|
41
|
+
tl-transform csv -C idd # one row per item, a links file, a file per cited source (zip)
|
|
42
|
+
tl-transform xlsx -C idd # the same as a read-only workbook that still sorts and filters
|
|
43
|
+
tl-transform docx -C idd # a Word document: title page, contents, a heading per item
|
|
44
|
+
tl-transform html -C idd # a print-ready page — print it to PDF from any browser
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
It is the command-line half of the
|
|
48
|
+
[throughline editor](https://github.com/rhodium-org/throughline-editor)'s export:
|
|
49
|
+
the same six forms, laid out the same way, from the graph as it stands on your
|
|
50
|
+
disk. The editor needs the graph on GitHub. This does not — it reads the working
|
|
51
|
+
tree, and the output says whether that tree was clean, carried uncommitted
|
|
52
|
+
changes, or was not under version control at all.
|
|
53
|
+
|
|
54
|
+
## What it does not do
|
|
55
|
+
|
|
56
|
+
**It never renders an item's words.** The Markdown is asked of `tl docs` over a
|
|
57
|
+
document of directives; the structure is read from `tl dump`. What this package
|
|
58
|
+
adds is the containers — a workbook, a Word document, a folder of notes, a
|
|
59
|
+
print-ready page — and the front matter and link syntax a note tool reads. If a
|
|
60
|
+
requirement here rendered prose, it would drift from what `tl docs --check`
|
|
61
|
+
gates, and a document that quietly differs from the published specification is
|
|
62
|
+
worse than none. That is [`NG-0001`](idd/non-goals/NG-0001.yml).
|
|
63
|
+
|
|
64
|
+
**It ships no PDF writer** ([`NG-0002`](idd/non-goals/NG-0002.yml)). Every
|
|
65
|
+
browser prints to PDF with a renderer that is already on the machine.
|
|
66
|
+
|
|
67
|
+
**It depends on nothing but the family.** `throughline` and
|
|
68
|
+
`throughline-compose`, and the standard library's `zipfile` for the two Office
|
|
69
|
+
formats, which are written from their own specifications.
|
|
70
|
+
|
|
71
|
+
## Which tool answers
|
|
72
|
+
|
|
73
|
+
A graph whose `throughline.toml` declares `[[sources]]` is read through
|
|
74
|
+
`tl-compose`; any other through `tl`. That is not cosmetic: over a composed graph
|
|
75
|
+
the core command exits cleanly and writes a borrowed clause as its synthetic uid
|
|
76
|
+
alone, dropping the reference number a conformance document exists to carry.
|
|
77
|
+
The tool is found beside this package's interpreter first and on the path
|
|
78
|
+
second, and is run as a command — its command line is the surface it publishes.
|
|
79
|
+
|
|
80
|
+
## The outputs
|
|
81
|
+
|
|
82
|
+
| Format | What you get |
|
|
83
|
+
|---|---|
|
|
84
|
+
| `md` | The tool's own document: a summary, a catalogue of every item in full, the mirrored clauses of adopted sources. `--body table` or `both` for a one-line-per-item table, `--matrix` for one traceability matrix per grounding link type, `--markers` to keep the region markers so `tl docs` can refill the file later. |
|
|
85
|
+
| `notes` | One Markdown note per item in a folder per register, YAML front matter as properties (type, status, attributes, the title as an alias, a tag each for type and status), every identifier a `[[wikilink]]`. Cited clauses under `sources/<namespace>/`, the colon in their name replaced by a space. Open the folder as an Obsidian vault: the graph view is the intent graph, and a note's backlinks are what rests on it. |
|
|
86
|
+
| `csv` | A zip of one file of items (or one per register with `--split per-register`), `links.csv` with one row per link naming the sheet at each end, one file per cited source, and the provenance. |
|
|
87
|
+
| `xlsx` | The same as sheets, read-only by recommendation with the structure locked and no password. Sorting and filtering stay allowed; a spreadsheet nobody can sort is one nobody can review. |
|
|
88
|
+
| `docx` | A title page with the provenance, a contents field Word fills in, a section per register, a heading per item with its type and status beneath, its words as a quotation, its rationale, its attributes in small print, and one appendix per cited source. |
|
|
89
|
+
| `html` | The same document as one self-contained page with print typography, A4 page rules and a contents list of links. Print it to PDF; the browser numbers the pages. |
|
|
90
|
+
| `blocks` | The document's structure as JSON — the same list of headings, quotations, paragraphs, attribute lines, tables and appendices the Word and HTML outputs are built from — for a front end that lays out its own pages. The editor's PDF is laid out from it. |
|
|
91
|
+
|
|
92
|
+
Every output carries the repository, ref, commit, working-tree state and tool
|
|
93
|
+
version it was taken from, because an output outlives the tree that made it and
|
|
94
|
+
the first question anyone asks of one is what it was true of. A caller that
|
|
95
|
+
knows them without git — the editor holds them from its clone — states them with
|
|
96
|
+
`--repository`, `--ref`, `--commit` and `--tree clean|dirty|untracked`, and git
|
|
97
|
+
is then not consulted.
|
|
98
|
+
|
|
99
|
+
## One implementation, two surfaces
|
|
100
|
+
|
|
101
|
+
The [throughline editor](https://github.com/rhodium-org/throughline-editor)
|
|
102
|
+
runs this package as a wheel under Pyodide beside `tl` and `tl-compose`, so an
|
|
103
|
+
export from a browser tab and an export from a terminal are the same bytes for
|
|
104
|
+
the same graph at the same commit. Pyodide has no processes, so there the tool
|
|
105
|
+
calls the console entry point `tl` or `tl-compose` declares in its package
|
|
106
|
+
metadata — the same function the command runs — instead of spawning it.
|
|
107
|
+
|
|
108
|
+
## Self-hosting
|
|
109
|
+
|
|
110
|
+
This repository's own requirements live under [`idd/`](idd) and compose
|
|
111
|
+
throughline's graph as a pinned source, so a requirement here can cite the
|
|
112
|
+
clause of the tool it reads (`satisfies: tl:SR-0111`) and have the citation
|
|
113
|
+
resolved rather than asserted.
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
tl-compose -C idd check --strict # the grounding gate
|
|
117
|
+
tl-compose -C idd docs --check # idd/docs/spec.md must match the graph
|
|
118
|
+
tl-transform html -C idd # and the tool over its own graph
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Apache-2.0. Created by Dr Henry J Grech-Cini; see [`PROVENANCE.md`](PROVENANCE.md).
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# throughline-transform
|
|
2
|
+
|
|
3
|
+
A [throughline](https://github.com/rhodium-org/throughline) requirements graph on
|
|
4
|
+
disk — committed or not — in the forms its readers open. One command, one file:
|
|
5
|
+
|
|
6
|
+
```bash
|
|
7
|
+
pipx install throughline-transform # pulls tl and tl-compose along too
|
|
8
|
+
|
|
9
|
+
tl-transform md -C idd # Markdown, written by the tool itself
|
|
10
|
+
tl-transform notes -C idd # a folder of notes for Obsidian (zip)
|
|
11
|
+
tl-transform notes -C idd --folder # …or the folder itself, ready to open as a vault
|
|
12
|
+
tl-transform csv -C idd # one row per item, a links file, a file per cited source (zip)
|
|
13
|
+
tl-transform xlsx -C idd # the same as a read-only workbook that still sorts and filters
|
|
14
|
+
tl-transform docx -C idd # a Word document: title page, contents, a heading per item
|
|
15
|
+
tl-transform html -C idd # a print-ready page — print it to PDF from any browser
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
It is the command-line half of the
|
|
19
|
+
[throughline editor](https://github.com/rhodium-org/throughline-editor)'s export:
|
|
20
|
+
the same six forms, laid out the same way, from the graph as it stands on your
|
|
21
|
+
disk. The editor needs the graph on GitHub. This does not — it reads the working
|
|
22
|
+
tree, and the output says whether that tree was clean, carried uncommitted
|
|
23
|
+
changes, or was not under version control at all.
|
|
24
|
+
|
|
25
|
+
## What it does not do
|
|
26
|
+
|
|
27
|
+
**It never renders an item's words.** The Markdown is asked of `tl docs` over a
|
|
28
|
+
document of directives; the structure is read from `tl dump`. What this package
|
|
29
|
+
adds is the containers — a workbook, a Word document, a folder of notes, a
|
|
30
|
+
print-ready page — and the front matter and link syntax a note tool reads. If a
|
|
31
|
+
requirement here rendered prose, it would drift from what `tl docs --check`
|
|
32
|
+
gates, and a document that quietly differs from the published specification is
|
|
33
|
+
worse than none. That is [`NG-0001`](idd/non-goals/NG-0001.yml).
|
|
34
|
+
|
|
35
|
+
**It ships no PDF writer** ([`NG-0002`](idd/non-goals/NG-0002.yml)). Every
|
|
36
|
+
browser prints to PDF with a renderer that is already on the machine.
|
|
37
|
+
|
|
38
|
+
**It depends on nothing but the family.** `throughline` and
|
|
39
|
+
`throughline-compose`, and the standard library's `zipfile` for the two Office
|
|
40
|
+
formats, which are written from their own specifications.
|
|
41
|
+
|
|
42
|
+
## Which tool answers
|
|
43
|
+
|
|
44
|
+
A graph whose `throughline.toml` declares `[[sources]]` is read through
|
|
45
|
+
`tl-compose`; any other through `tl`. That is not cosmetic: over a composed graph
|
|
46
|
+
the core command exits cleanly and writes a borrowed clause as its synthetic uid
|
|
47
|
+
alone, dropping the reference number a conformance document exists to carry.
|
|
48
|
+
The tool is found beside this package's interpreter first and on the path
|
|
49
|
+
second, and is run as a command — its command line is the surface it publishes.
|
|
50
|
+
|
|
51
|
+
## The outputs
|
|
52
|
+
|
|
53
|
+
| Format | What you get |
|
|
54
|
+
|---|---|
|
|
55
|
+
| `md` | The tool's own document: a summary, a catalogue of every item in full, the mirrored clauses of adopted sources. `--body table` or `both` for a one-line-per-item table, `--matrix` for one traceability matrix per grounding link type, `--markers` to keep the region markers so `tl docs` can refill the file later. |
|
|
56
|
+
| `notes` | One Markdown note per item in a folder per register, YAML front matter as properties (type, status, attributes, the title as an alias, a tag each for type and status), every identifier a `[[wikilink]]`. Cited clauses under `sources/<namespace>/`, the colon in their name replaced by a space. Open the folder as an Obsidian vault: the graph view is the intent graph, and a note's backlinks are what rests on it. |
|
|
57
|
+
| `csv` | A zip of one file of items (or one per register with `--split per-register`), `links.csv` with one row per link naming the sheet at each end, one file per cited source, and the provenance. |
|
|
58
|
+
| `xlsx` | The same as sheets, read-only by recommendation with the structure locked and no password. Sorting and filtering stay allowed; a spreadsheet nobody can sort is one nobody can review. |
|
|
59
|
+
| `docx` | A title page with the provenance, a contents field Word fills in, a section per register, a heading per item with its type and status beneath, its words as a quotation, its rationale, its attributes in small print, and one appendix per cited source. |
|
|
60
|
+
| `html` | The same document as one self-contained page with print typography, A4 page rules and a contents list of links. Print it to PDF; the browser numbers the pages. |
|
|
61
|
+
| `blocks` | The document's structure as JSON — the same list of headings, quotations, paragraphs, attribute lines, tables and appendices the Word and HTML outputs are built from — for a front end that lays out its own pages. The editor's PDF is laid out from it. |
|
|
62
|
+
|
|
63
|
+
Every output carries the repository, ref, commit, working-tree state and tool
|
|
64
|
+
version it was taken from, because an output outlives the tree that made it and
|
|
65
|
+
the first question anyone asks of one is what it was true of. A caller that
|
|
66
|
+
knows them without git — the editor holds them from its clone — states them with
|
|
67
|
+
`--repository`, `--ref`, `--commit` and `--tree clean|dirty|untracked`, and git
|
|
68
|
+
is then not consulted.
|
|
69
|
+
|
|
70
|
+
## One implementation, two surfaces
|
|
71
|
+
|
|
72
|
+
The [throughline editor](https://github.com/rhodium-org/throughline-editor)
|
|
73
|
+
runs this package as a wheel under Pyodide beside `tl` and `tl-compose`, so an
|
|
74
|
+
export from a browser tab and an export from a terminal are the same bytes for
|
|
75
|
+
the same graph at the same commit. Pyodide has no processes, so there the tool
|
|
76
|
+
calls the console entry point `tl` or `tl-compose` declares in its package
|
|
77
|
+
metadata — the same function the command runs — instead of spawning it.
|
|
78
|
+
|
|
79
|
+
## Self-hosting
|
|
80
|
+
|
|
81
|
+
This repository's own requirements live under [`idd/`](idd) and compose
|
|
82
|
+
throughline's graph as a pinned source, so a requirement here can cite the
|
|
83
|
+
clause of the tool it reads (`satisfies: tl:SR-0111`) and have the citation
|
|
84
|
+
resolved rather than asserted.
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
tl-compose -C idd check --strict # the grounding gate
|
|
88
|
+
tl-compose -C idd docs --check # idd/docs/spec.md must match the graph
|
|
89
|
+
tl-transform html -C idd # and the tool over its own graph
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Apache-2.0. Created by Dr Henry J Grech-Cini; see [`PROVENANCE.md`](PROVENANCE.md).
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "throughline-transform"
|
|
7
|
+
version = "0.2.0"
|
|
8
|
+
description = "Turn a throughline requirements graph on disk, committed or not, into the forms its readers open: Markdown, a folder of Obsidian notes, CSV, an Excel workbook, a Word document, or a print-ready HTML document. Ships the tl-transform CLI."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.11"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
license-files = ["LICENSE", "NOTICE"]
|
|
13
|
+
authors = [{ name = "Henry J Grech-Cini", email = "henry.grechcini@gmail.com" }]
|
|
14
|
+
keywords = [
|
|
15
|
+
"requirements",
|
|
16
|
+
"requirements-management",
|
|
17
|
+
"export",
|
|
18
|
+
"obsidian",
|
|
19
|
+
"docx",
|
|
20
|
+
"xlsx",
|
|
21
|
+
"markdown",
|
|
22
|
+
"traceability",
|
|
23
|
+
"idd",
|
|
24
|
+
"intent-driven-development",
|
|
25
|
+
"throughline",
|
|
26
|
+
]
|
|
27
|
+
classifiers = [
|
|
28
|
+
"Development Status :: 3 - Alpha",
|
|
29
|
+
"Environment :: Console",
|
|
30
|
+
"Intended Audience :: Developers",
|
|
31
|
+
"Operating System :: OS Independent",
|
|
32
|
+
"Programming Language :: Python :: 3",
|
|
33
|
+
"Programming Language :: Python :: 3.11",
|
|
34
|
+
"Programming Language :: Python :: 3.12",
|
|
35
|
+
"Topic :: Software Development :: Documentation",
|
|
36
|
+
"Topic :: Office/Business",
|
|
37
|
+
]
|
|
38
|
+
# The prose of every output is the tool's own: this package asks `tl docs` for the
|
|
39
|
+
# Markdown and `tl dump` for the structure, and writes nothing of an item itself
|
|
40
|
+
# (SR-0002). `tl:catalog` and `tl:sourced` as they are rendered from 2.2.0 and
|
|
41
|
+
# 0.16.1 are the shapes this package reads (SR-0003); it was written against those
|
|
42
|
+
# releases and the floors say so. compose 0.16.1 requires throughline 2.2.0, so the
|
|
43
|
+
# two floors are one fact stated at both ends.
|
|
44
|
+
dependencies = ["throughline-compose>=0.16.1", "throughline>=2.2.0"]
|
|
45
|
+
|
|
46
|
+
[project.optional-dependencies]
|
|
47
|
+
dev = ["pytest>=8.0"]
|
|
48
|
+
|
|
49
|
+
[project.urls]
|
|
50
|
+
Homepage = "https://github.com/rhodium-org/throughline-transform"
|
|
51
|
+
Repository = "https://github.com/rhodium-org/throughline-transform"
|
|
52
|
+
Issues = "https://github.com/rhodium-org/throughline-transform/issues"
|
|
53
|
+
|
|
54
|
+
[project.scripts]
|
|
55
|
+
tl-transform = "throughline_transform.cli:main"
|
|
56
|
+
throughline-transform = "throughline_transform.cli:main"
|
|
57
|
+
|
|
58
|
+
[tool.setuptools.packages.find]
|
|
59
|
+
where = ["src"]
|
|
60
|
+
|
|
61
|
+
[tool.pytest.ini_options]
|
|
62
|
+
testpaths = ["tests"]
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Copyright (c) 2026 Henry J Grech-Cini
|
|
2
|
+
# SPDX-License-Identifier: Apache-2.0
|
|
3
|
+
"""throughline-transform: a throughline graph on disk, in the forms its readers open.
|
|
4
|
+
|
|
5
|
+
Everything here reads what the tool writes. The Markdown comes from ``tl docs``
|
|
6
|
+
over a document of directives; the structure comes from ``tl dump``. What this
|
|
7
|
+
package adds is the containers — a workbook, a Word document, a folder of notes,
|
|
8
|
+
a print-ready page — and never a second rendering of an item's words.
|
|
9
|
+
"""
|
|
10
|
+
|
|
11
|
+
from .project import TransformError
|
|
12
|
+
|
|
13
|
+
__all__ = ["TransformError"]
|