issue-boundary-evidence 0.1.2__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.
- issue_boundary_evidence-0.1.2/LICENSE +202 -0
- issue_boundary_evidence-0.1.2/PKG-INFO +144 -0
- issue_boundary_evidence-0.1.2/README.md +131 -0
- issue_boundary_evidence-0.1.2/pyproject.toml +23 -0
- issue_boundary_evidence-0.1.2/setup.cfg +4 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence/__init__.py +4 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence/cli.py +47 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence/extract.py +689 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence/github.py +92 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence/models.py +58 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence/report.py +72 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence/retrieve.py +51 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence.egg-info/PKG-INFO +144 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence.egg-info/SOURCES.txt +22 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence.egg-info/dependency_links.txt +1 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence.egg-info/entry_points.txt +2 -0
- issue_boundary_evidence-0.1.2/src/issue_boundary_evidence.egg-info/top_level.txt +1 -0
- issue_boundary_evidence-0.1.2/tests/test_confidence.py +289 -0
- issue_boundary_evidence-0.1.2/tests/test_extract_packages.py +29 -0
- issue_boundary_evidence-0.1.2/tests/test_extract_versions.py +134 -0
- issue_boundary_evidence-0.1.2/tests/test_github_links.py +46 -0
- issue_boundary_evidence-0.1.2/tests/test_history_and_services.py +160 -0
- issue_boundary_evidence-0.1.2/tests/test_report.py +33 -0
- issue_boundary_evidence-0.1.2/tests/test_retrieve.py +49 -0
|
@@ -0,0 +1,202 @@
|
|
|
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.
|
|
202
|
+
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: issue-boundary-evidence
|
|
3
|
+
Version: 0.1.2
|
|
4
|
+
Summary: Read-only, deterministic boundary evidence extraction for public GitHub issues
|
|
5
|
+
Author: Issue Boundary Evidence contributors
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Repository, https://github.com/LaimaWu/issue-boundary-evidence
|
|
8
|
+
Project-URL: Issues, https://github.com/LaimaWu/issue-boundary-evidence/issues
|
|
9
|
+
Requires-Python: >=3.10
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Dynamic: license-file
|
|
13
|
+
|
|
14
|
+
# Issue Boundary Evidence
|
|
15
|
+
|
|
16
|
+
A small read-only CLI for OSS maintainers that extracts traceable dependency, upstream, runtime, and version-history evidence from public GitHub Issues.
|
|
17
|
+
|
|
18
|
+
## Why
|
|
19
|
+
|
|
20
|
+
Some issues are not hard because the code change is difficult. They are hard because the maintainer first has to determine:
|
|
21
|
+
|
|
22
|
+
- which package, plugin, runtime, or external system is involved;
|
|
23
|
+
- whether behavior changed across versions;
|
|
24
|
+
- whether investigation belongs upstream;
|
|
25
|
+
- what evidence is still missing.
|
|
26
|
+
|
|
27
|
+
Issue Boundary Evidence collects those clues without changing the issue or claiming to decide the root cause.
|
|
28
|
+
|
|
29
|
+
## What it does
|
|
30
|
+
|
|
31
|
+
Given one public GitHub Issue URL, the CLI reads the title, body, all comments, and a small number of explicitly referenced same-repository issues or pull requests. It produces a Markdown report with:
|
|
32
|
+
|
|
33
|
+
- environment, package, ABI, and version facts;
|
|
34
|
+
- dependency, plugin, runtime, and upstream boundary candidates;
|
|
35
|
+
- version and regression clues;
|
|
36
|
+
- contextual same-repository commit-history clues;
|
|
37
|
+
- external repository/service domains found in CI or infrastructure context;
|
|
38
|
+
- related GitHub evidence;
|
|
39
|
+
- explicit evidence gaps;
|
|
40
|
+
- source URL, source kind, location, and excerpt for every evidence item.
|
|
41
|
+
|
|
42
|
+
Each item is typed as `fact`, `strong_clue`, or `weak_clue`. These labels measure evidence strength; they are not final root-cause or bug-owner decisions.
|
|
43
|
+
|
|
44
|
+
## What it does not do
|
|
45
|
+
|
|
46
|
+
It does not comment, label, close, or otherwise modify GitHub Issues. It does not run issue code, follow arbitrary downloads, clone linked repositories, fix bugs, use an LLM/API, or replace maintainer judgment.
|
|
47
|
+
|
|
48
|
+
## Requirements
|
|
49
|
+
|
|
50
|
+
- Python 3.10 or newer
|
|
51
|
+
- Network access to public `api.github.com`
|
|
52
|
+
- Optional `GITHUB_TOKEN` for a higher GitHub read-only API rate limit
|
|
53
|
+
|
|
54
|
+
There are no runtime package dependencies.
|
|
55
|
+
|
|
56
|
+
## Install from the v0.1.2 GitHub release
|
|
57
|
+
|
|
58
|
+
Install the wheel attached to the v0.1.2 GitHub release:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
python -m pip install https://github.com/LaimaWu/issue-boundary-evidence/releases/download/v0.1.2/issue_boundary_evidence-0.1.2-py3-none-any.whl
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## PyPI installation pending
|
|
65
|
+
|
|
66
|
+
PyPI publication is not live yet. After the first Trusted Publishing run succeeds, the package will be installable with:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
python -m pip install issue-boundary-evidence
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Until then, use the GitHub release wheel or the contributor installation below.
|
|
73
|
+
|
|
74
|
+
## Contributor install
|
|
75
|
+
|
|
76
|
+
From the repository root:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
python3 -m venv .venv
|
|
80
|
+
. .venv/bin/activate
|
|
81
|
+
python -m pip install -e .
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Run
|
|
85
|
+
|
|
86
|
+
Print a report:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
issue-boundary-evidence https://github.com/OWNER/REPO/issues/123
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Write it to a file:
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
issue-boundary-evidence https://github.com/OWNER/REPO/issues/123 --output report.md
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Run without installing:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
PYTHONPATH=src python -m issue_boundary_evidence.cli https://github.com/OWNER/REPO/issues/123
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Test
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
PYTHONPATH=src python -m unittest discover -s tests -v
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
The unit tests use local fixtures and do not require network access.
|
|
111
|
+
|
|
112
|
+
## Examples
|
|
113
|
+
|
|
114
|
+
Generated reports are in [`examples/`](examples/):
|
|
115
|
+
|
|
116
|
+
- `pandas-58927.md`
|
|
117
|
+
- `pytest-12430.md`
|
|
118
|
+
- `numpy-26622.md`
|
|
119
|
+
|
|
120
|
+
The complete frozen ten-issue precision-pass run is stored in [`eval_outputs/`](eval_outputs/). These are raw CLI reports for human retrospective scoring; the project does not assign its own GO/REVISE/STOP score.
|
|
121
|
+
|
|
122
|
+
## Retrieval boundary
|
|
123
|
+
|
|
124
|
+
The CLI uses only GitHub's public, read-only REST endpoints. It fetches all comments on the requested issue. It retrieves up to five same-repository issues or pull requests only when the issue or comments explicitly link them or use contextual wording such as `see #123`, `PR #123`, or `fixed by #123`. Bare numbers and references inside code fences are not retrieved. Contextual commit SHAs are linked without fetching their diffs. Non-GitHub service URLs can identify an infrastructure boundary, but the CLI records their domains without requesting them.
|
|
125
|
+
|
|
126
|
+
Version-like values are extracted deterministically, then the report prioritizes versions tied to the current repository, complete Python/runtime tokens, boundary language, compatibility, regression, or release/fix prose. Markdown-linked patch versions are supported. This avoids presenting every compiler, package-name substring, or toolchain value in a large environment dump as equally important.
|
|
127
|
+
|
|
128
|
+
Packaging tools such as `pip`, `setuptools`, and `wheel` are promoted only when their version or behavior directly affects the investigation—for example, selecting the correct ABI wheel. Generic install commands, CI logs, and package lists are not sufficient. Quoted copies of identical regression sentences are collapsed while retaining their source links.
|
|
129
|
+
|
|
130
|
+
## Security
|
|
131
|
+
|
|
132
|
+
All issue content is untrusted text. The tool never evaluates or executes issue bodies, comments, code blocks, commands, or reporter-provided scripts. HTTP methods are limited to `GET`; no GitHub write operations exist in the client.
|
|
133
|
+
|
|
134
|
+
## Validation
|
|
135
|
+
|
|
136
|
+
This is an experimental deterministic maintainer tool. The repository includes a frozen retrospective evaluation set built from historical pandas, pytest, and NumPy issues where maintainers later discussed dependency, runtime, upstream, infrastructure, or version-history boundaries. Raw generated reports are stored in [`eval_outputs/`](eval_outputs/). This evaluation is intended to expose strengths and failure modes; it is not a claim of universal accuracy.
|
|
137
|
+
|
|
138
|
+
## Current status
|
|
139
|
+
|
|
140
|
+
Experimental deterministic CLI. See [`EVAL_NOTES.md`](EVAL_NOTES.md) for the retrospective evaluation procedure.
|
|
141
|
+
|
|
142
|
+
## License
|
|
143
|
+
|
|
144
|
+
Apache-2.0.
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# Issue Boundary Evidence
|
|
2
|
+
|
|
3
|
+
A small read-only CLI for OSS maintainers that extracts traceable dependency, upstream, runtime, and version-history evidence from public GitHub Issues.
|
|
4
|
+
|
|
5
|
+
## Why
|
|
6
|
+
|
|
7
|
+
Some issues are not hard because the code change is difficult. They are hard because the maintainer first has to determine:
|
|
8
|
+
|
|
9
|
+
- which package, plugin, runtime, or external system is involved;
|
|
10
|
+
- whether behavior changed across versions;
|
|
11
|
+
- whether investigation belongs upstream;
|
|
12
|
+
- what evidence is still missing.
|
|
13
|
+
|
|
14
|
+
Issue Boundary Evidence collects those clues without changing the issue or claiming to decide the root cause.
|
|
15
|
+
|
|
16
|
+
## What it does
|
|
17
|
+
|
|
18
|
+
Given one public GitHub Issue URL, the CLI reads the title, body, all comments, and a small number of explicitly referenced same-repository issues or pull requests. It produces a Markdown report with:
|
|
19
|
+
|
|
20
|
+
- environment, package, ABI, and version facts;
|
|
21
|
+
- dependency, plugin, runtime, and upstream boundary candidates;
|
|
22
|
+
- version and regression clues;
|
|
23
|
+
- contextual same-repository commit-history clues;
|
|
24
|
+
- external repository/service domains found in CI or infrastructure context;
|
|
25
|
+
- related GitHub evidence;
|
|
26
|
+
- explicit evidence gaps;
|
|
27
|
+
- source URL, source kind, location, and excerpt for every evidence item.
|
|
28
|
+
|
|
29
|
+
Each item is typed as `fact`, `strong_clue`, or `weak_clue`. These labels measure evidence strength; they are not final root-cause or bug-owner decisions.
|
|
30
|
+
|
|
31
|
+
## What it does not do
|
|
32
|
+
|
|
33
|
+
It does not comment, label, close, or otherwise modify GitHub Issues. It does not run issue code, follow arbitrary downloads, clone linked repositories, fix bugs, use an LLM/API, or replace maintainer judgment.
|
|
34
|
+
|
|
35
|
+
## Requirements
|
|
36
|
+
|
|
37
|
+
- Python 3.10 or newer
|
|
38
|
+
- Network access to public `api.github.com`
|
|
39
|
+
- Optional `GITHUB_TOKEN` for a higher GitHub read-only API rate limit
|
|
40
|
+
|
|
41
|
+
There are no runtime package dependencies.
|
|
42
|
+
|
|
43
|
+
## Install from the v0.1.2 GitHub release
|
|
44
|
+
|
|
45
|
+
Install the wheel attached to the v0.1.2 GitHub release:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
python -m pip install https://github.com/LaimaWu/issue-boundary-evidence/releases/download/v0.1.2/issue_boundary_evidence-0.1.2-py3-none-any.whl
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## PyPI installation pending
|
|
52
|
+
|
|
53
|
+
PyPI publication is not live yet. After the first Trusted Publishing run succeeds, the package will be installable with:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
python -m pip install issue-boundary-evidence
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Until then, use the GitHub release wheel or the contributor installation below.
|
|
60
|
+
|
|
61
|
+
## Contributor install
|
|
62
|
+
|
|
63
|
+
From the repository root:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
python3 -m venv .venv
|
|
67
|
+
. .venv/bin/activate
|
|
68
|
+
python -m pip install -e .
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Run
|
|
72
|
+
|
|
73
|
+
Print a report:
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
issue-boundary-evidence https://github.com/OWNER/REPO/issues/123
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Write it to a file:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
issue-boundary-evidence https://github.com/OWNER/REPO/issues/123 --output report.md
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Run without installing:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
PYTHONPATH=src python -m issue_boundary_evidence.cli https://github.com/OWNER/REPO/issues/123
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Test
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
PYTHONPATH=src python -m unittest discover -s tests -v
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
The unit tests use local fixtures and do not require network access.
|
|
98
|
+
|
|
99
|
+
## Examples
|
|
100
|
+
|
|
101
|
+
Generated reports are in [`examples/`](examples/):
|
|
102
|
+
|
|
103
|
+
- `pandas-58927.md`
|
|
104
|
+
- `pytest-12430.md`
|
|
105
|
+
- `numpy-26622.md`
|
|
106
|
+
|
|
107
|
+
The complete frozen ten-issue precision-pass run is stored in [`eval_outputs/`](eval_outputs/). These are raw CLI reports for human retrospective scoring; the project does not assign its own GO/REVISE/STOP score.
|
|
108
|
+
|
|
109
|
+
## Retrieval boundary
|
|
110
|
+
|
|
111
|
+
The CLI uses only GitHub's public, read-only REST endpoints. It fetches all comments on the requested issue. It retrieves up to five same-repository issues or pull requests only when the issue or comments explicitly link them or use contextual wording such as `see #123`, `PR #123`, or `fixed by #123`. Bare numbers and references inside code fences are not retrieved. Contextual commit SHAs are linked without fetching their diffs. Non-GitHub service URLs can identify an infrastructure boundary, but the CLI records their domains without requesting them.
|
|
112
|
+
|
|
113
|
+
Version-like values are extracted deterministically, then the report prioritizes versions tied to the current repository, complete Python/runtime tokens, boundary language, compatibility, regression, or release/fix prose. Markdown-linked patch versions are supported. This avoids presenting every compiler, package-name substring, or toolchain value in a large environment dump as equally important.
|
|
114
|
+
|
|
115
|
+
Packaging tools such as `pip`, `setuptools`, and `wheel` are promoted only when their version or behavior directly affects the investigation—for example, selecting the correct ABI wheel. Generic install commands, CI logs, and package lists are not sufficient. Quoted copies of identical regression sentences are collapsed while retaining their source links.
|
|
116
|
+
|
|
117
|
+
## Security
|
|
118
|
+
|
|
119
|
+
All issue content is untrusted text. The tool never evaluates or executes issue bodies, comments, code blocks, commands, or reporter-provided scripts. HTTP methods are limited to `GET`; no GitHub write operations exist in the client.
|
|
120
|
+
|
|
121
|
+
## Validation
|
|
122
|
+
|
|
123
|
+
This is an experimental deterministic maintainer tool. The repository includes a frozen retrospective evaluation set built from historical pandas, pytest, and NumPy issues where maintainers later discussed dependency, runtime, upstream, infrastructure, or version-history boundaries. Raw generated reports are stored in [`eval_outputs/`](eval_outputs/). This evaluation is intended to expose strengths and failure modes; it is not a claim of universal accuracy.
|
|
124
|
+
|
|
125
|
+
## Current status
|
|
126
|
+
|
|
127
|
+
Experimental deterministic CLI. See [`EVAL_NOTES.md`](EVAL_NOTES.md) for the retrospective evaluation procedure.
|
|
128
|
+
|
|
129
|
+
## License
|
|
130
|
+
|
|
131
|
+
Apache-2.0.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=68"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "issue-boundary-evidence"
|
|
7
|
+
version = "0.1.2"
|
|
8
|
+
description = "Read-only, deterministic boundary evidence extraction for public GitHub issues"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
authors = [{ name = "Issue Boundary Evidence contributors" }]
|
|
13
|
+
dependencies = []
|
|
14
|
+
|
|
15
|
+
[project.urls]
|
|
16
|
+
Repository = "https://github.com/LaimaWu/issue-boundary-evidence"
|
|
17
|
+
Issues = "https://github.com/LaimaWu/issue-boundary-evidence/issues"
|
|
18
|
+
|
|
19
|
+
[project.scripts]
|
|
20
|
+
issue-boundary-evidence = "issue_boundary_evidence.cli:main"
|
|
21
|
+
|
|
22
|
+
[tool.setuptools.packages.find]
|
|
23
|
+
where = ["src"]
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import argparse
|
|
4
|
+
import sys
|
|
5
|
+
from pathlib import Path
|
|
6
|
+
|
|
7
|
+
from .github import GitHubError
|
|
8
|
+
from .report import render_report
|
|
9
|
+
from .retrieve import analyze_issue
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
def build_parser() -> argparse.ArgumentParser:
|
|
13
|
+
parser = argparse.ArgumentParser(
|
|
14
|
+
prog="issue-boundary-evidence",
|
|
15
|
+
description="Produce a read-only Markdown boundary-evidence report for a public GitHub issue.",
|
|
16
|
+
)
|
|
17
|
+
parser.add_argument("issue_url", help="Public GitHub issue URL")
|
|
18
|
+
parser.add_argument("-o", "--output", type=Path, help="Write Markdown to this file instead of stdout")
|
|
19
|
+
parser.add_argument(
|
|
20
|
+
"--related-limit",
|
|
21
|
+
type=int,
|
|
22
|
+
default=5,
|
|
23
|
+
choices=range(0, 11),
|
|
24
|
+
metavar="0..10",
|
|
25
|
+
help="Maximum explicitly referenced same-repository issues/PRs to retrieve (default: 5)",
|
|
26
|
+
)
|
|
27
|
+
return parser
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
def main(argv: list[str] | None = None) -> int:
|
|
31
|
+
args = build_parser().parse_args(argv)
|
|
32
|
+
try:
|
|
33
|
+
analysis = analyze_issue(args.issue_url, related_limit=args.related_limit)
|
|
34
|
+
report = render_report(analysis)
|
|
35
|
+
except (ValueError, GitHubError) as exc:
|
|
36
|
+
print(f"error: {exc}", file=sys.stderr)
|
|
37
|
+
return 2
|
|
38
|
+
if args.output:
|
|
39
|
+
args.output.write_text(report, encoding="utf-8")
|
|
40
|
+
else:
|
|
41
|
+
print(report)
|
|
42
|
+
return 0
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
if __name__ == "__main__":
|
|
46
|
+
raise SystemExit(main())
|
|
47
|
+
|