reqtable 0.1.0__py3-none-any.whl
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.
- reqtable/__init__.py +3 -0
- reqtable/__main__.py +3 -0
- reqtable/baselines.py +920 -0
- reqtable/cli.py +631 -0
- reqtable/comparison.py +63 -0
- reqtable/core.py +1448 -0
- reqtable/drafts.py +166 -0
- reqtable/findings.py +605 -0
- reqtable/gate_checks.py +84 -0
- reqtable/gates.py +348 -0
- reqtable/glossary.py +162 -0
- reqtable/gui.py +952 -0
- reqtable/gui_lookups.py +192 -0
- reqtable/gui_mapping.py +789 -0
- reqtable/gui_page.py +691 -0
- reqtable/gui_page_gates.py +173 -0
- reqtable/gui_page_mapping.py +390 -0
- reqtable/gui_server.py +467 -0
- reqtable/html_report.py +2595 -0
- reqtable/markdown.py +127 -0
- reqtable/package.py +163 -0
- reqtable/quality.py +422 -0
- reqtable/review.py +318 -0
- reqtable/signoff.py +179 -0
- reqtable/traceability.py +1670 -0
- reqtable/values.py +192 -0
- reqtable/waivers.py +109 -0
- reqtable/xlsx.py +1108 -0
- reqtable-0.1.0.dist-info/METADATA +106 -0
- reqtable-0.1.0.dist-info/RECORD +33 -0
- reqtable-0.1.0.dist-info/WHEEL +4 -0
- reqtable-0.1.0.dist-info/entry_points.txt +2 -0
- reqtable-0.1.0.dist-info/licenses/LICENSE +21 -0
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: reqtable
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Offline requirements table and diff report generator.
|
|
5
|
+
Project-URL: Homepage, https://github.com/patrick984/reqtable
|
|
6
|
+
Project-URL: Source, https://github.com/patrick984/reqtable
|
|
7
|
+
Project-URL: Issues, https://github.com/patrick984/reqtable/issues
|
|
8
|
+
Author: Patrick Norman
|
|
9
|
+
License-Expression: MIT
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: csv,report,requirements,traceability,xlsx
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Environment :: Console
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Intended Audience :: Science/Research
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
22
|
+
Classifier: Topic :: Software Development :: Documentation
|
|
23
|
+
Requires-Python: >=3.10
|
|
24
|
+
Description-Content-Type: text/markdown
|
|
25
|
+
|
|
26
|
+
# Requirements Table Generator
|
|
27
|
+
|
|
28
|
+
`reqtable` turns a requirements CSV (or Excel workbook) into an interactive, self-contained HTML report. It can also compare two CSV snapshots and show line- and word-level changes in unified or side-by-side views. Tables support sorting, per-column filters, column visibility, drag resizing, and divider double-click auto-sizing.
|
|
29
|
+
|
|
30
|
+
The generator uses only the Python standard library. Generated reports contain all CSS, JavaScript, data, and review comments in one file and work offline.
|
|
31
|
+
|
|
32
|
+
## Install
|
|
33
|
+
|
|
34
|
+
Python 3.10 or later is required. The HTML report targets current versions of Chrome, Edge, Firefox, and Safari.
|
|
35
|
+
|
|
36
|
+
Install the `reqtable` command with [uv](https://docs.astral.sh/uv/):
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
uv tool install git+https://github.com/patrick984/reqtable
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Then run `reqtable` from any folder. Upgrade with `uv tool upgrade reqtable`.
|
|
43
|
+
|
|
44
|
+
Or build a single-file program from a checkout:
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
python build.py
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
The build writes `dist/reqtable.pyz`.
|
|
51
|
+
|
|
52
|
+
The examples here and in [docs/](docs/) write `python reqtable.pyz` for short. With the installed command, run `reqtable` instead (`reqtable requirements.csv --id-column ID -o requirements.html`). With the single-file build, use `dist/reqtable.pyz`, or copy it next to your CSV.
|
|
53
|
+
|
|
54
|
+
## Quick start
|
|
55
|
+
|
|
56
|
+
If you would rather not type commands, start the [point-and-click GUI](docs/gui.md):
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
python reqtable.pyz --gui
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Snapshot report:
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
python reqtable.pyz requirements.csv --id-column ID -o requirements.html
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Editable Develop report:
|
|
69
|
+
|
|
70
|
+
```sh
|
|
71
|
+
python reqtable.pyz requirements.csv --id-column ID \
|
|
72
|
+
--document-mode develop -o requirements-develop.html
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Diff report:
|
|
76
|
+
|
|
77
|
+
```sh
|
|
78
|
+
python reqtable.pyz --old requirements-old.csv --new requirements-new.csv \
|
|
79
|
+
--id-column ID -o requirements-diff.html
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Extract comments from a reviewed report:
|
|
83
|
+
|
|
84
|
+
```sh
|
|
85
|
+
python reqtable.pyz --extract-comments requirements-reviewed-PN.html \
|
|
86
|
+
--id-column ID -o requirements-reviewed.csv
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Use `--csv-base union` when extracting a diff report if comments on removed requirements must be retained.
|
|
90
|
+
|
|
91
|
+
## Documentation
|
|
92
|
+
|
|
93
|
+
- [Point-and-click GUI](docs/gui.md): run every task from a browser form instead of the command line.
|
|
94
|
+
- [Review and Develop modes](docs/review-and-develop.md): the two report modes, saving, handing off for review, and review comments.
|
|
95
|
+
- [Read from Excel](docs/excel.md): import workbooks, repair untidy rows, and combine several tables with a saved mapping.
|
|
96
|
+
- [Configuration](docs/configuration.md): the JSON settings file.
|
|
97
|
+
- [Keyboard use](docs/keyboard.md): shortcuts, editing, selection, and requirement quality checks.
|
|
98
|
+
- [Use as a Git diff tool](docs/git.md): compare reports in `git difftool`, or against a git tag or commit.
|
|
99
|
+
- Traceability:
|
|
100
|
+
- [Systems and traceability pilot](docs/traceability.md): systems, links, needs and sources.
|
|
101
|
+
- [Project glossary](docs/glossary.md)
|
|
102
|
+
- [Allowed values](docs/allowed-values.md)
|
|
103
|
+
- [Tests and verification](docs/tests-and-verification.md)
|
|
104
|
+
- [Gates, baselines and sign-off](docs/gates.md): freeze baselines, check gate readiness, waivers, review packages, sign-off and change control.
|
|
105
|
+
- [Build and test](docs/development.md): for contributors.
|
|
106
|
+
- Design and planning: the [generator spec](docs/design/requirements-table-generator-spec.md), the [baselines](docs/design/requirements-baselines-proposal.md) and [traceability](docs/design/requirements-traceability-proposal.md) proposals, the [UAT checklist](docs/uat/UAT-CHECKLIST.md) and the [TODO list](docs/planning/TODO.md).
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
reqtable/__init__.py,sha256=XORasA_Vg_7A7zGO2DEaaM_rz4SK8GsISYTAEGgMWzc,83
|
|
2
|
+
reqtable/__main__.py,sha256=k1ocEWawweo1qCJWNFAAvyxz3tcY13dzvCenHszij30,48
|
|
3
|
+
reqtable/baselines.py,sha256=KCz6nBUZAix1u9UnIWgX2aWSErzyEKTNLJW4ET_mkrw,32496
|
|
4
|
+
reqtable/cli.py,sha256=fSgyH4SvU64bm0aTngw4PbO2sc3vG7b6-kfcfCIGtSM,23097
|
|
5
|
+
reqtable/comparison.py,sha256=PVMK8VSwpDwwgCN9N5sNE5MSS6eZ_uuNsc1DhUsFvaw,3275
|
|
6
|
+
reqtable/core.py,sha256=1aSZi8pgbOJsDgkarRyx7KRSm-GB69Oc32ym2SdTyuA,53843
|
|
7
|
+
reqtable/drafts.py,sha256=hDP4s6c4ThByRxyWnhPsBGAiGKHBxYc8z_P6jDJxeMk,8316
|
|
8
|
+
reqtable/findings.py,sha256=rOYa_d2Tuv_i8Ui6SKctIhX6hE6nNfHXoPZQwfs4aNo,21895
|
|
9
|
+
reqtable/gate_checks.py,sha256=mcgoPdPxHsI-c6cOEZAeSpFPzFgAMbwTGxWFf255abM,5019
|
|
10
|
+
reqtable/gates.py,sha256=J7eBpKHX_csHEs1tyixtmDYJp6FCYlBSOt35Jb3BFRQ,11892
|
|
11
|
+
reqtable/glossary.py,sha256=qkYUGYpnogK5XS0KJlgskKaa8U4EfV8mNL4yvmkV4xI,7249
|
|
12
|
+
reqtable/gui.py,sha256=X1Kx-PDz1h3XJ1VBt1xKYs-Hlmz8Azu6iwD0HwL1K8M,31787
|
|
13
|
+
reqtable/gui_lookups.py,sha256=9IpGMoK-ApZ2pvEBTqQOORFO6tmfffrhlyFEk76dKd4,6621
|
|
14
|
+
reqtable/gui_mapping.py,sha256=NL4Jl2o0eRN-t20y3c7EwiU7ovVtY5OmststaIfffVQ,27257
|
|
15
|
+
reqtable/gui_page.py,sha256=b_hW43zG0yY4PXuoC4kqeqAcJTEFSnqCsWe3jFmJI-g,41093
|
|
16
|
+
reqtable/gui_page_gates.py,sha256=5DgKyix1fTucDQyCI_7lOWCimu-oizApSgn8InxWqGA,10908
|
|
17
|
+
reqtable/gui_page_mapping.py,sha256=NqWbRzJIhTkkBrw_3BwQ6H5gYKVhKQiWuzSkAfiLXvw,26536
|
|
18
|
+
reqtable/gui_server.py,sha256=L-qO6G5y2kkiGm0IMeBQi8hnfzJpEdu_M8BqxYp8rLQ,17262
|
|
19
|
+
reqtable/html_report.py,sha256=oWTD-avPj6e7J5piSyYbRCKM8h9xdmYEwUWmvJBs59E,182442
|
|
20
|
+
reqtable/markdown.py,sha256=sJwXPmDgZJSMHcOD99u6BFj29bZoI_1i-u1QzEsGlE8,4217
|
|
21
|
+
reqtable/package.py,sha256=Z9nnD27ablReOwfYAIwW_BAwJ3r4JQviSGY5p5r-alc,11513
|
|
22
|
+
reqtable/quality.py,sha256=8l3quxU8FIPvYhuBc80vs6b7BNnzMobdrGZT88Xdjqk,18686
|
|
23
|
+
reqtable/review.py,sha256=SZToQrlw7guoKqDPfIKqm3KgYud76UKxr-U86RqIGuY,10817
|
|
24
|
+
reqtable/signoff.py,sha256=R7L3I9dGDj4CqPlmovixYgh8Lie-6cjl00E0RL3vF4E,6048
|
|
25
|
+
reqtable/traceability.py,sha256=ham0z4XxKqZH5JUQBZxkh9Mj2djDnZvdDcZwBRYzu2Y,89928
|
|
26
|
+
reqtable/values.py,sha256=dYITUklBilKLKERcC_WUafICqaLZDz4TgR84gj08OPo,7912
|
|
27
|
+
reqtable/waivers.py,sha256=oH_HNnungti0EQ9nQ-nHrVT26zg0YYpSIwSsNvg_RiI,3487
|
|
28
|
+
reqtable/xlsx.py,sha256=smV4xh8xau5S1oBi9_cMFnfSVdvjKfY22B7pvmRCvMU,39555
|
|
29
|
+
reqtable-0.1.0.dist-info/METADATA,sha256=TYjgGIdyEDbiNAXKFXp89XrUHrKlZx80XgTPzmaNyL4,4537
|
|
30
|
+
reqtable-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
|
|
31
|
+
reqtable-0.1.0.dist-info/entry_points.txt,sha256=6Bi3hRsDbazAQF-es28cgAcFidNQ51lbOQMVqRUqUy0,47
|
|
32
|
+
reqtable-0.1.0.dist-info/licenses/LICENSE,sha256=fjY25Hiz_vYL0VYTVvxeEiB0u8a2hqs04zvz2w3Zxec,1071
|
|
33
|
+
reqtable-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Patrick Norman
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|