PTSIP 0.3.1__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.
- ptsip-0.3.1/LICENSE +201 -0
- ptsip-0.3.1/MANIFEST.in +1 -0
- ptsip-0.3.1/PKG-INFO +338 -0
- ptsip-0.3.1/README.md +307 -0
- ptsip-0.3.1/pyproject.toml +55 -0
- ptsip-0.3.1/setup.cfg +4 -0
- ptsip-0.3.1/src/PTSIP.egg-info/PKG-INFO +338 -0
- ptsip-0.3.1/src/PTSIP.egg-info/SOURCES.txt +70 -0
- ptsip-0.3.1/src/PTSIP.egg-info/dependency_links.txt +1 -0
- ptsip-0.3.1/src/PTSIP.egg-info/entry_points.txt +3 -0
- ptsip-0.3.1/src/PTSIP.egg-info/requires.txt +9 -0
- ptsip-0.3.1/src/PTSIP.egg-info/top_level.txt +1 -0
- ptsip-0.3.1/src/ptsip/__init__.py +3 -0
- ptsip-0.3.1/src/ptsip/__main__.py +4 -0
- ptsip-0.3.1/src/ptsip/app/__init__.py +5 -0
- ptsip-0.3.1/src/ptsip/app/client.py +53 -0
- ptsip-0.3.1/src/ptsip/app/github_client.py +200 -0
- ptsip-0.3.1/src/ptsip/app/server.py +130 -0
- ptsip-0.3.1/src/ptsip/app/service.py +285 -0
- ptsip-0.3.1/src/ptsip/app/store.py +233 -0
- ptsip-0.3.1/src/ptsip/artifact_evidence.py +150 -0
- ptsip-0.3.1/src/ptsip/build_resolution.py +298 -0
- ptsip-0.3.1/src/ptsip/clarification/__init__.py +6 -0
- ptsip-0.3.1/src/ptsip/clarification/generator.py +120 -0
- ptsip-0.3.1/src/ptsip/clarification/generator_core.py +98 -0
- ptsip-0.3.1/src/ptsip/clarification/i18n.py +106 -0
- ptsip-0.3.1/src/ptsip/clarification/model.py +33 -0
- ptsip-0.3.1/src/ptsip/clarification/render.py +78 -0
- ptsip-0.3.1/src/ptsip/clarification/resolution/__init__.py +29 -0
- ptsip-0.3.1/src/ptsip/clarification/resolution/model.py +33 -0
- ptsip-0.3.1/src/ptsip/clarification/resolution/parser.py +56 -0
- ptsip-0.3.1/src/ptsip/clarification/resolution/profile_projection.py +198 -0
- ptsip-0.3.1/src/ptsip/clarification/resolution/resolver.py +30 -0
- ptsip-0.3.1/src/ptsip/clarification/transports/__init__.py +1 -0
- ptsip-0.3.1/src/ptsip/clarification/transports/github_issue.py +162 -0
- ptsip-0.3.1/src/ptsip/cli.py +402 -0
- ptsip-0.3.1/src/ptsip/conformance.py +531 -0
- ptsip-0.3.1/src/ptsip/conformance_audit.py +143 -0
- ptsip-0.3.1/src/ptsip/conformance_engine.py +396 -0
- ptsip-0.3.1/src/ptsip/constants.py +9 -0
- ptsip-0.3.1/src/ptsip/doctor.py +33 -0
- ptsip-0.3.1/src/ptsip/inspection/__init__.py +1 -0
- ptsip-0.3.1/src/ptsip/inspection/components.py +74 -0
- ptsip-0.3.1/src/ptsip/inspection/dependencies.py +496 -0
- ptsip-0.3.1/src/ptsip/inspection/dependencies_030.py +69 -0
- ptsip-0.3.1/src/ptsip/inspection/dotnet.py +188 -0
- ptsip-0.3.1/src/ptsip/inspection/go.py +157 -0
- ptsip-0.3.1/src/ptsip/inspection/inventory.py +161 -0
- ptsip-0.3.1/src/ptsip/inspection/javascript.py +376 -0
- ptsip-0.3.1/src/ptsip/inspection/lexing.py +121 -0
- ptsip-0.3.1/src/ptsip/inspection/source_adapters.py +60 -0
- ptsip-0.3.1/src/ptsip/lifecycle_evidence.py +245 -0
- ptsip-0.3.1/src/ptsip/model.py +105 -0
- ptsip-0.3.1/src/ptsip/pilot/__init__.py +1 -0
- ptsip-0.3.1/src/ptsip/pilot/runner.py +170 -0
- ptsip-0.3.1/src/ptsip/repository/__init__.py +1 -0
- ptsip-0.3.1/src/ptsip/repository/discover.py +68 -0
- ptsip-0.3.1/src/ptsip/repository/remote.py +54 -0
- ptsip-0.3.1/src/ptsip/repository/snapshot.py +173 -0
- ptsip-0.3.1/src/ptsip/review_evidence.py +406 -0
- ptsip-0.3.1/src/ptsip/spec_identity.py +22 -0
- ptsip-0.3.1/src/ptsip/specdata/ptsip-agent-classification.schema.json +35 -0
- ptsip-0.3.1/src/ptsip/specdata/ptsip-artifact-evidence.schema.json +68 -0
- ptsip-0.3.1/src/ptsip/specdata/ptsip-diagnostic.schema.json +29 -0
- ptsip-0.3.1/src/ptsip/specdata/ptsip-profile.schema.json +310 -0
- ptsip-0.3.1/src/ptsip/specdata/ptsip-registry.yaml +189 -0
- ptsip-0.3.1/src/ptsip/storage/__init__.py +1 -0
- ptsip-0.3.1/src/ptsip/storage/local_state.py +32 -0
- ptsip-0.3.1/src/ptsip/validation/__init__.py +1 -0
- ptsip-0.3.1/src/ptsip/validation/components.py +164 -0
- ptsip-0.3.1/src/ptsip/validation/profile.py +172 -0
- ptsip-0.3.1/src/ptsip/validation/rules.py +163 -0
ptsip-0.3.1/LICENSE
ADDED
|
@@ -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 [yyyy] [name of copyright owner]
|
|
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.
|
ptsip-0.3.1/MANIFEST.in
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
prune tests
|
ptsip-0.3.1/PKG-INFO
ADDED
|
@@ -0,0 +1,338 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: PTSIP
|
|
3
|
+
Version: 0.3.1
|
|
4
|
+
Summary: Reference development tooling for the Product-Toolchain SDK Isolation Policy
|
|
5
|
+
Author: kwaksinwoo01
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/kwaksinwoo01/ptsip
|
|
8
|
+
Project-URL: Specification, https://github.com/kwaksinwoo01/ptsip
|
|
9
|
+
Project-URL: Issues, https://github.com/kwaksinwoo01/ptsip/issues
|
|
10
|
+
Keywords: architecture,sdk,toolchain,governance,validation,ptsip
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Environment :: Console
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
19
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
20
|
+
Requires-Python: >=3.11
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Requires-Dist: PyYAML<7,>=6.0
|
|
24
|
+
Requires-Dist: jsonschema<5,>=4.23
|
|
25
|
+
Provides-Extra: github-app
|
|
26
|
+
Requires-Dist: PyJWT[crypto]<3,>=2.10; extra == "github-app"
|
|
27
|
+
Provides-Extra: dev
|
|
28
|
+
Requires-Dist: build<2,>=1.2; extra == "dev"
|
|
29
|
+
Requires-Dist: pytest<9,>=8; extra == "dev"
|
|
30
|
+
Dynamic: license-file
|
|
31
|
+
|
|
32
|
+
<p align="right">
|
|
33
|
+
English | <a href="README.ko.md">한국어</a>
|
|
34
|
+
</p>
|
|
35
|
+
|
|
36
|
+
# PTSIP — Product–Toolchain SDK Isolation Policy
|
|
37
|
+
|
|
38
|
+
**Status:** Draft project-defined specification
|
|
39
|
+
**Specification family:** Software architecture / SDK governance / development toolchain isolation
|
|
40
|
+
**License:** Apache License 2.0
|
|
41
|
+
|
|
42
|
+
PTSIP (Product–Toolchain SDK Isolation Policy) is a project-defined architecture policy for managing Software Development Kits (SDKs) according to their **purpose, packaging responsibility, dependency boundary, build environment, and lifecycle**.
|
|
43
|
+
|
|
44
|
+
> **Purpose precedes reuse.** Classify a component by why it exists and which lifecycle owns it before considering code-sharing opportunities.
|
|
45
|
+
|
|
46
|
+
## Why PTSIP exists
|
|
47
|
+
|
|
48
|
+
In large or long-lived codebases, validators, schema helpers, generators, migration modules, and generic utilities can gradually become shared by both product runtime code and development tooling. That creates hidden coupling:
|
|
49
|
+
|
|
50
|
+
- development-only dependencies leak into product packaging;
|
|
51
|
+
- toolchain changes force product releases;
|
|
52
|
+
- product compatibility concerns block toolchain evolution;
|
|
53
|
+
- generic `common` packages erase architectural ownership;
|
|
54
|
+
- code reuse becomes more important than lifecycle independence.
|
|
55
|
+
|
|
56
|
+
PTSIP makes the opposite trade-off: **lifecycle and responsibility boundaries are primary; reuse is conditional.**
|
|
57
|
+
|
|
58
|
+
## Architecture at a glance
|
|
59
|
+
|
|
60
|
+
PTSIP distinguishes two primary SDK planes:
|
|
61
|
+
|
|
62
|
+
| Plane | Responsibility |
|
|
63
|
+
| --- | --- |
|
|
64
|
+
| **Product SDK Plane** | SDKs and libraries that are part of, support, or are distributed with the product. |
|
|
65
|
+
| **Toolchain SDK Plane** | SDKs and development tools used to build, validate, migrate, test, generate, inspect, release, or otherwise develop the product. |
|
|
66
|
+
|
|
67
|
+
PTSIP defines exactly three architectural classifications:
|
|
68
|
+
|
|
69
|
+
| Classification | Meaning |
|
|
70
|
+
| --- | --- |
|
|
71
|
+
| `PRODUCT` | Product-owned runtime, library, SDK, or distributed component. |
|
|
72
|
+
| `TOOLCHAIN` | Development-only tooling or SDK component owned by the development lifecycle. |
|
|
73
|
+
| `NEUTRAL_CONTRACT` | A deliberately neutral contract that may be shared without collapsing Product and Toolchain ownership. |
|
|
74
|
+
|
|
75
|
+
Inspection states such as `UNKNOWN`, `CONFLICT`, and `INCOMPLETE` describe unresolved decisions. They are not additional architectural classifications or SDK planes.
|
|
76
|
+
|
|
77
|
+
PTSIP does not claim that host/target separation, build-time/runtime separation, toolchain isolation, or independent lifecycle management are new ideas. It combines these established ideas into an explicit SDK-governance boundary with conformance rules and machine-readable project metadata.
|
|
78
|
+
|
|
79
|
+
## Install and use
|
|
80
|
+
|
|
81
|
+
PTSIP requires Python 3.11 or newer.
|
|
82
|
+
|
|
83
|
+
Install the latest published Reference Tool from PyPI:
|
|
84
|
+
|
|
85
|
+
```powershell
|
|
86
|
+
pip install PTSIP
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
For a project dependency, prefer a **minimum compatible version** over an exact release pin unless reproducibility requires exact pinning. For example, a project that requires the 0.2+ interface can declare:
|
|
90
|
+
|
|
91
|
+
```text
|
|
92
|
+
# requirements.txt
|
|
93
|
+
ptsip>=0.2.0
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
That requirement is a compatibility floor, not a declaration of the latest PTSIP release.
|
|
97
|
+
|
|
98
|
+
Common commands:
|
|
99
|
+
|
|
100
|
+
```powershell
|
|
101
|
+
ptsip --version
|
|
102
|
+
ptsip spec
|
|
103
|
+
ptsip doctor .
|
|
104
|
+
ptsip inspect .
|
|
105
|
+
ptsip pilot .
|
|
106
|
+
ptsip validate .
|
|
107
|
+
ptsip clarify .
|
|
108
|
+
ptsip gate .
|
|
109
|
+
ptsip resolve --help
|
|
110
|
+
ptsip conform .
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
For source development:
|
|
114
|
+
|
|
115
|
+
```powershell
|
|
116
|
+
pip install -e ".[dev]"
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Specification and Tool lifecycle
|
|
120
|
+
|
|
121
|
+
The **PTSIP Specification** and the **PTSIP Reference Tool** have independent release lifecycles. A Tool version does not imply a Specification release with the same version number.
|
|
122
|
+
|
|
123
|
+
This README intentionally does **not** duplicate the current Tool version, latest published release number, or immutable Specification revision. Those values have authoritative sources:
|
|
124
|
+
|
|
125
|
+
- [`pyproject.toml`](pyproject.toml) — Tool source version and package metadata;
|
|
126
|
+
- [GitHub Releases](https://github.com/kwaksinwoo01/ptsip/releases) — published Tool and Specification releases;
|
|
127
|
+
- `ptsip --version` — installed Tool version;
|
|
128
|
+
- `ptsip spec` — Specification identity bound to the installed Tool;
|
|
129
|
+
- [`spec/`](spec/) and [`registry/ptsip-registry.yaml`](registry/ptsip-registry.yaml) — canonical Specification content and machine-readable identity.
|
|
130
|
+
|
|
131
|
+
This keeps the project overview readable and prevents routine release work from requiring README version edits.
|
|
132
|
+
|
|
133
|
+
## Consumer Repository non-intrusion
|
|
134
|
+
|
|
135
|
+
PTSIP does not require adopting repositories to create PTSIP-specific `docs/`, `tools/`, `.ptsip/`, cache, or report directories.
|
|
136
|
+
|
|
137
|
+
External PTSIP inspection and Pilot tooling is read-only against the Consumer Repository by default. Tool-owned state should remain outside that repository unless the user explicitly chooses otherwise.
|
|
138
|
+
|
|
139
|
+
A project may voluntarily provide a machine-readable profile for enforced conformance, but the profile location remains a project/configuration concern rather than a required repository topology.
|
|
140
|
+
|
|
141
|
+
## Human clarification without speculative inference
|
|
142
|
+
|
|
143
|
+
When PTSIP detects a component candidate but the Consumer Repository does not declare enough architectural intent to classify it safely, `ptsip clarify` can stop at the missing facts and ask the project owner instead of expanding speculative inference.
|
|
144
|
+
|
|
145
|
+
Clarification generation is deterministic: it uses repository evidence, fixed completeness rules, and fixed question templates. It does **not** call an LLM or model API, and JSON output explicitly reports `llm_calls: 0` and `speculative_classification: false`.
|
|
146
|
+
|
|
147
|
+
The clarification interface supports English and Korean prompts only. Language selection follows `--lang en|ko`, then `PTSIP_LANG`, then the operating-system locale, with English as the fallback.
|
|
148
|
+
|
|
149
|
+
```powershell
|
|
150
|
+
ptsip clarify . --lang ko
|
|
151
|
+
ptsip clarify . --json
|
|
152
|
+
ptsip clarify . --component tools
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Clarification is read-only by default. The older explicit Issue publisher remains available as a manual/offline fallback:
|
|
156
|
+
|
|
157
|
+
```powershell
|
|
158
|
+
ptsip clarify . --publish github-issue
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
PTSIP reads the inspected Git repository's `origin` and, for GitHub HTTPS or SSH remotes, derives the default `owner/repository`. An explicit override is available when needed:
|
|
162
|
+
|
|
163
|
+
```powershell
|
|
164
|
+
ptsip clarify . --publish github-issue --repo owner/repository
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
The manual publisher requires an authenticated `gh` CLI only for the explicit publish operation. Its duplicate-publication state is stored under `PTSIP_HOME/clarifications`, outside the Consumer Repository. Free-form Issue replies are not interpreted by an LLM.
|
|
168
|
+
|
|
169
|
+
## Coding-agent decision gate
|
|
170
|
+
|
|
171
|
+
Tool 0.3.1 adds an **on-demand** human architecture-decision workflow for coding-agent sessions. It does not run a reminder timer or scheduled poll. A coding agent calls `ptsip gate` only when its current boundary-sensitive task actually needs a decision that the repository does not yet declare.
|
|
172
|
+
|
|
173
|
+
```powershell
|
|
174
|
+
ptsip gate . --component tools --json
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
When the decision is unresolved, the configured PTSIP decision control plane creates or reuses a GitHub clarification Issue and `ptsip gate` reports `DECISION_REQUIRED`. The coding agent should stop only the affected work and ask the user to decide. If no active coding-agent task needs the decision, PTSIP does not remind the user.
|
|
178
|
+
|
|
179
|
+
The user can resolve the pending decision through either channel:
|
|
180
|
+
|
|
181
|
+
- **Active coding-agent chat:** the coding agent records the user's explicit facts with the write-enabled `ptsip resolve` command.
|
|
182
|
+
- **GitHub Issue:** the GitHub App accepts the fixed `ptsip-clarification-answer/v1` YAML structure from an authorized repository writer through an `issue_comment` webhook.
|
|
183
|
+
|
|
184
|
+
Example chat-originated resolution:
|
|
185
|
+
|
|
186
|
+
```powershell
|
|
187
|
+
ptsip resolve . `
|
|
188
|
+
--decision clr-example `
|
|
189
|
+
--classification TOOLCHAIN `
|
|
190
|
+
--purpose "Repository migration tooling" `
|
|
191
|
+
--shipped no `
|
|
192
|
+
--runtime-required no `
|
|
193
|
+
--lifecycle-owner DEVELOPMENT_TOOLING `
|
|
194
|
+
--executable yes
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
The control plane uses compare-and-set semantics: **the first valid resolution wins**. After a decision is resolved, a later contradictory chat or Issue answer cannot replace it. When chat resolution is successfully projected into `ptsip.yaml`, the linked Issue is completed; later replies are ignored.
|
|
198
|
+
|
|
199
|
+
Issue-originated profile application is bound to the recorded repository revision and uses a non-force Git ref update. If the branch has changed, PTSIP preserves the already accepted human decision but does not silently apply it to the changed snapshot; the active coding agent must reconcile that resolved decision against the current repository state.
|
|
200
|
+
|
|
201
|
+
The GitHub Issue is an asynchronous interaction surface. The decision-control-plane store is authoritative for workflow state, while `ptsip.yaml` remains the Consumer Repository's architecture declaration. See [`reference/DECISION-CONTROL-PLANE.md`](reference/DECISION-CONTROL-PLANE.md) for the Tool-level workflow and reference service contract.
|
|
202
|
+
|
|
203
|
+
The GitHub App runtime is optional for ordinary local PTSIP use:
|
|
204
|
+
|
|
205
|
+
```powershell
|
|
206
|
+
pip install "ptsip[github-app]"
|
|
207
|
+
ptsip-app --help
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
## Enforced conformance evaluation
|
|
211
|
+
|
|
212
|
+
`ptsip conform` combines the Project Profile with observed repository evidence and explicitly supplied artifact/review evidence. It reports only `CONFORMANT`, `NON_CONFORMANT`, or `INCOMPLETE`; `NOT_EVALUATED` remains an execution state used by workflows such as Pilot evidence collection.
|
|
213
|
+
|
|
214
|
+
A basic machine-readable run is:
|
|
215
|
+
|
|
216
|
+
```powershell
|
|
217
|
+
ptsip conform . --artifact-evidence path/to/artifact-evidence.json --json
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
Explicit evidence inputs are repeatable and read-only:
|
|
221
|
+
|
|
222
|
+
```powershell
|
|
223
|
+
ptsip conform . `
|
|
224
|
+
--artifact-evidence product-artifact.json `
|
|
225
|
+
--agent-decision component-review.json `
|
|
226
|
+
--external-evidence validator-evidence.json `
|
|
227
|
+
--json
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
- `--artifact-evidence` accepts `ptsip-artifact-evidence/v1` and evaluates Product packaging without treating the artifact producer as the artifact owner. Strict use also requires a Tool-level, non-normative `<artifact-path>.binding.json` sidecar with format `ptsip-artifact-evidence-binding/v1`, the artifact SHA-256, and a `subject` containing the exact Consumer Repository identity, revision, and tracked-content fingerprint. Missing, stale, or mismatched binding remains `INCOMPLETE`; the canonical artifact evidence schema is unchanged.
|
|
231
|
+
- `--agent-decision` accepts the bound `ptsip-agent-classification` decision contract. Agent decisions are review evidence and never silently overwrite the Project Profile.
|
|
232
|
+
- `--external-evidence` accepts the Reference Tool `ptsip-external-evidence/v1` input envelope. The producer, Consumer Repository identity, exact repository revision, evidence provenance, and imported-file SHA-256 are preserved. Stale or contradictory evidence blocks a strict claim instead of overriding native evidence.
|
|
233
|
+
|
|
234
|
+
The Tool collects dependency evidence from Python, JavaScript/TypeScript and npm, Go source/modules, .NET project/source metadata, and GitHub Actions local-script invocations. Unsupported executable source in Product/Toolchain ownership is a blocking coverage gap, while documentation and ordinary non-source files are not blocked merely by extension. It also evaluates ownership-compatible declared component manifests for independent build resolution and uses path-scoped release automation plus declared release/compatibility ownership as bounded lifecycle evidence.
|
|
235
|
+
|
|
236
|
+
`CONFORMANT` is emitted only when applicable mandatory-rule evidence is sufficient for the supported evaluation scope and the final diagnostic/coverage contract audit passes. A definite mandatory violation produces `NON_CONFORMANT`; an unresolved target, invalid/stale evidence input, incomplete artifact evidence, ambiguous build/lifecycle evidence, or another gap capable of hiding a mandatory violation produces `INCOMPLETE`.
|
|
237
|
+
|
|
238
|
+
CLI exit codes for `ptsip conform` are:
|
|
239
|
+
|
|
240
|
+
| Exit code | Outcome |
|
|
241
|
+
| --- | --- |
|
|
242
|
+
| `0` | `CONFORMANT` |
|
|
243
|
+
| `5` | `NON_CONFORMANT` |
|
|
244
|
+
| `6` | `INCOMPLETE` |
|
|
245
|
+
|
|
246
|
+
The Tool does not restructure the Consumer Repository or auto-approve architecture exceptions. Tool 0.3.1 may write a Project Profile only through an explicit user-authorized resolution workflow or an authorized structured GitHub Issue decision; conformance evaluation still treats the resulting profile as a declaration that must be checked against observed evidence.
|
|
247
|
+
|
|
248
|
+
## Reference Tool
|
|
249
|
+
|
|
250
|
+
The independently versioned Reference Tool is implemented under [`src/ptsip/`](src/ptsip/). The repository is shared with the Specification, but their release lifecycles remain separate.
|
|
251
|
+
|
|
252
|
+
The current tooling focuses on:
|
|
253
|
+
|
|
254
|
+
- read-only repository inspection;
|
|
255
|
+
- Pilot evidence collection;
|
|
256
|
+
- repository snapshot and non-intrusion evidence;
|
|
257
|
+
- component and multi-language dependency evidence;
|
|
258
|
+
- deterministic human clarification for missing architectural intent;
|
|
259
|
+
- on-demand coding-agent decision gating and explicit human resolution;
|
|
260
|
+
- optional GitHub App/Webhook decision synchronization without scheduled reminders;
|
|
261
|
+
- project-profile validation;
|
|
262
|
+
- explicit Product Artifact evidence ingestion and packaging evaluation;
|
|
263
|
+
- independent build-resolution and bounded lifecycle evidence evaluation;
|
|
264
|
+
- constrained coding-agent decision ingestion as review evidence;
|
|
265
|
+
- revision-bound external dependency evidence import with provenance;
|
|
266
|
+
- deterministic Enforced Conformance evaluation and diagnostic/coverage auditing.
|
|
267
|
+
|
|
268
|
+
Conformance is evidence-relative rather than detection-relative: unsupported, unresolved, contradictory, stale, or incomplete evidence that can conceal an applicable `MUST`/`MUST NOT` result prevents `CONFORMANT` even when no violation has been detected.
|
|
269
|
+
|
|
270
|
+
Pilot state is stored outside the repository by default (`%LOCALAPPDATA%\PTSIP` on Windows and the platform-equivalent user state directory elsewhere). `PTSIP_HOME` can override that location.
|
|
271
|
+
|
|
272
|
+
Tool releases use the `tool-v*` tag/release namespace. Specification releases may use a separate `spec-v*` namespace.
|
|
273
|
+
|
|
274
|
+
## Repository map
|
|
275
|
+
|
|
276
|
+
| Area | Location | Purpose |
|
|
277
|
+
| --- | --- | --- |
|
|
278
|
+
| Normative Specification | [`spec/`](spec/) | Architecture rules, terminology, governance, and conformance requirements. |
|
|
279
|
+
| Machine-readable rules | [`registry/`](registry/) | Canonical terminology and rule registry. |
|
|
280
|
+
| Schemas | [`schemas/`](schemas/) | Project profile, diagnostics, artifact evidence, and coding-agent decision schemas. |
|
|
281
|
+
| Reference architecture | [`reference/`](reference/) | Informative architecture guidance. |
|
|
282
|
+
| Adoption guidance | [`adoption/`](adoption/) | Migration and adoption sequence. |
|
|
283
|
+
| Agent contract | [`agents/`](agents/) | Concise rules for coding agents. |
|
|
284
|
+
| Example profiles | [`profiles/`](profiles/) | Example PTSIP project profiles. |
|
|
285
|
+
| Architecture decisions | [`decisions/`](decisions/) | Specification decision records. |
|
|
286
|
+
| Reference Tool | [`src/ptsip/`](src/ptsip/) | Installable Python implementation. |
|
|
287
|
+
| Tool tests | [`tests/`](tests/) | Reference Tool verification. |
|
|
288
|
+
|
|
289
|
+
Important repository files and automation:
|
|
290
|
+
|
|
291
|
+
- [`pyproject.toml`](pyproject.toml) — Python package/build metadata;
|
|
292
|
+
- [`releasenote/`](releasenote/) — versioned Reference Tool and Specification release/history notes;
|
|
293
|
+
- [`.github/workflows/tooling-test.yml`](.github/workflows/tooling-test.yml) — Tool CI;
|
|
294
|
+
- [`.github/workflows/tooling-release.yml`](.github/workflows/tooling-release.yml) — PyPI Trusted Publishing for `tool-v*` releases;
|
|
295
|
+
- [`.github/workflows/readme-translation.yml`](.github/workflows/readme-translation.yml) — automatic Korean README synchronization;
|
|
296
|
+
- [`.github/scripts/sync_readme_ko.py`](.github/scripts/sync_readme_ko.py) — README translation and structural-validation helper;
|
|
297
|
+
- [`README.md`](README.md) — canonical English project overview;
|
|
298
|
+
- [`README.ko.md`](README.ko.md) — automatically synchronized Korean translation.
|
|
299
|
+
|
|
300
|
+
## README localization
|
|
301
|
+
|
|
302
|
+
`README.md` is the canonical project overview. `README.ko.md` is a translated view and should not become an independently maintained source of project facts.
|
|
303
|
+
|
|
304
|
+
When the English README changes on `main`, [`.github/workflows/readme-translation.yml`](.github/workflows/readme-translation.yml) regenerates the Korean README and commits the result. The workflow calls GitHub Models with the repository-provided `GITHUB_TOKEN`, so a separate model API secret is not required.
|
|
305
|
+
|
|
306
|
+
Before writing the translation, the helper at [`.github/scripts/sync_readme_ko.py`](.github/scripts/sync_readme_ko.py) checks Markdown heading structure, fenced code blocks, link destinations, normative keywords, and suspicious output length. A structurally unsafe model response fails the workflow instead of overwriting `README.ko.md`.
|
|
307
|
+
|
|
308
|
+
This avoids routine manual translation work while reducing the risk of the two documents drifting apart.
|
|
309
|
+
|
|
310
|
+
## Normative language
|
|
311
|
+
|
|
312
|
+
The words **MUST**, **MUST NOT**, **SHOULD**, **SHOULD NOT**, and **MAY** are used as normative requirement keywords in the sense of BCP 14 (RFC 2119 as updated by RFC 8174) when, and only when, they appear in uppercase.
|
|
313
|
+
|
|
314
|
+
References:
|
|
315
|
+
|
|
316
|
+
- RFC 2119: https://www.rfc-editor.org/info/rfc2119/
|
|
317
|
+
- RFC 8174: https://www.rfc-editor.org/info/rfc8174/
|
|
318
|
+
|
|
319
|
+
## Relationship to existing concepts
|
|
320
|
+
|
|
321
|
+
PTSIP is related to, but not identical with:
|
|
322
|
+
|
|
323
|
+
- host / execution / target separation;
|
|
324
|
+
- build-time / runtime dependency separation;
|
|
325
|
+
- toolchain isolation;
|
|
326
|
+
- dependency graph isolation;
|
|
327
|
+
- independent release lifecycle management;
|
|
328
|
+
- hermetic or reproducible build practices.
|
|
329
|
+
|
|
330
|
+
## Maturity
|
|
331
|
+
|
|
332
|
+
PTSIP is a **draft project-defined specification**, not an ISO, IEEE, IETF, CNCF, or other external industry standard.
|
|
333
|
+
|
|
334
|
+
The public specification is intended to make the policy reproducible: a person, coding agent, or external validator should be able to identify the governing Specification and independently evaluate a repository against it.
|
|
335
|
+
|
|
336
|
+
## License
|
|
337
|
+
|
|
338
|
+
This repository, including the PTSIP Specification and Reference Tool unless explicitly stated otherwise, is licensed under the **Apache License, Version 2.0**. See [`LICENSE`](LICENSE).
|