proofpath 0.0.1__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.
- proofpath/__init__.py +5 -0
- proofpath/cli.py +69 -0
- proofpath/py.typed +0 -0
- proofpath-0.0.1.dist-info/METADATA +112 -0
- proofpath-0.0.1.dist-info/RECORD +8 -0
- proofpath-0.0.1.dist-info/WHEEL +4 -0
- proofpath-0.0.1.dist-info/entry_points.txt +2 -0
- proofpath-0.0.1.dist-info/licenses/LICENSE +21 -0
proofpath/__init__.py
ADDED
proofpath/cli.py
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
"""Command-line entry point.
|
|
2
|
+
|
|
3
|
+
The TUI and the one-shot commands are two front-ends over a single ``verify()``
|
|
4
|
+
call. Neither holds logic of its own; see the design spec, section 13.
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
from __future__ import annotations
|
|
8
|
+
|
|
9
|
+
import sys
|
|
10
|
+
from pathlib import Path
|
|
11
|
+
from typing import Annotated
|
|
12
|
+
|
|
13
|
+
import typer
|
|
14
|
+
|
|
15
|
+
from proofpath import __version__
|
|
16
|
+
|
|
17
|
+
app = typer.Typer(
|
|
18
|
+
name="proofpath",
|
|
19
|
+
help="Check whether the sources behind a claim actually say what the claim says.",
|
|
20
|
+
no_args_is_help=False,
|
|
21
|
+
add_completion=True,
|
|
22
|
+
)
|
|
23
|
+
|
|
24
|
+
# Exit codes are part of the interface: CI can gate on them without parsing text.
|
|
25
|
+
EXIT_CLEAN = 0
|
|
26
|
+
EXIT_FINDINGS = 1
|
|
27
|
+
EXIT_ERROR = 2
|
|
28
|
+
|
|
29
|
+
_NOT_BUILT_YET = (
|
|
30
|
+
"proofpath is at the design stage — the verification pipeline is not implemented yet.\n"
|
|
31
|
+
"\n"
|
|
32
|
+
" design spec https://github.com/Yigtwxx/proofpath/blob/main/docs/superpowers/specs/2026-09-10-proofpath-design.md\n"
|
|
33
|
+
" plan https://github.com/Yigtwxx/proofpath/blob/main/docs/superpowers/plans/2026-09-10-proofpath-implementation-plan.md\n"
|
|
34
|
+
" open items https://github.com/Yigtwxx/proofpath/blob/main/docs/superpowers/OPEN-ITEMS.md\n"
|
|
35
|
+
)
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
def _version_callback(value: bool) -> None:
|
|
39
|
+
if value:
|
|
40
|
+
typer.echo(f"proofpath {__version__}")
|
|
41
|
+
raise typer.Exit(EXIT_CLEAN)
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
@app.callback(invoke_without_command=True)
|
|
45
|
+
def main(
|
|
46
|
+
ctx: typer.Context,
|
|
47
|
+
version: Annotated[
|
|
48
|
+
bool,
|
|
49
|
+
typer.Option("--version", callback=_version_callback, is_eager=True, help="Show version."),
|
|
50
|
+
] = False,
|
|
51
|
+
) -> None:
|
|
52
|
+
"""Launch the interactive TUI when called with no subcommand."""
|
|
53
|
+
if ctx.invoked_subcommand is not None:
|
|
54
|
+
return
|
|
55
|
+
typer.echo(_NOT_BUILT_YET)
|
|
56
|
+
raise typer.Exit(EXIT_CLEAN)
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
@app.command()
|
|
60
|
+
def check(
|
|
61
|
+
target: Annotated[Path, typer.Argument(help="Document to check.")],
|
|
62
|
+
) -> None:
|
|
63
|
+
"""Verify every citation in a document and write a report."""
|
|
64
|
+
typer.echo(_NOT_BUILT_YET, err=True)
|
|
65
|
+
raise typer.Exit(EXIT_ERROR)
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
if __name__ == "__main__": # pragma: no cover
|
|
69
|
+
sys.exit(app())
|
proofpath/py.typed
ADDED
|
File without changes
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: proofpath
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Check whether the sources behind a claim actually say what the claim says.
|
|
5
|
+
Project-URL: Homepage, https://github.com/Yigtwxx/proofpath
|
|
6
|
+
Project-URL: Repository, https://github.com/Yigtwxx/proofpath
|
|
7
|
+
Project-URL: Issues, https://github.com/Yigtwxx/proofpath/issues
|
|
8
|
+
Project-URL: Changelog, https://github.com/Yigtwxx/proofpath/blob/main/CHANGELOG.md
|
|
9
|
+
Author: Yigit Erdogan
|
|
10
|
+
License: MIT License
|
|
11
|
+
|
|
12
|
+
Copyright (c) 2026 Yigit Erdogan
|
|
13
|
+
|
|
14
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
15
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
16
|
+
in the Software without restriction, including without limitation the rights
|
|
17
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
18
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
19
|
+
furnished to do so, subject to the following conditions:
|
|
20
|
+
|
|
21
|
+
The above copyright notice and this permission notice shall be included in all
|
|
22
|
+
copies or substantial portions of the Software.
|
|
23
|
+
|
|
24
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
25
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
26
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
27
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
28
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
29
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
30
|
+
SOFTWARE.
|
|
31
|
+
License-File: LICENSE
|
|
32
|
+
Keywords: citation,cli,entailment,fact-checking,nli,rag,research-integrity,retrieval-augmented-generation
|
|
33
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
34
|
+
Classifier: Environment :: Console
|
|
35
|
+
Classifier: Intended Audience :: Science/Research
|
|
36
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
37
|
+
Classifier: Operating System :: OS Independent
|
|
38
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
39
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
40
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
41
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
42
|
+
Classifier: Topic :: Scientific/Engineering
|
|
43
|
+
Classifier: Topic :: Text Processing :: Linguistic
|
|
44
|
+
Classifier: Typing :: Typed
|
|
45
|
+
Requires-Python: >=3.10
|
|
46
|
+
Requires-Dist: curl-cffi>=0.16.1
|
|
47
|
+
Requires-Dist: fastembed>=0.5
|
|
48
|
+
Requires-Dist: httpx>=0.28
|
|
49
|
+
Requires-Dist: orjson>=3.11
|
|
50
|
+
Requires-Dist: platformdirs>=4.3
|
|
51
|
+
Requires-Dist: pymupdf>=1.25
|
|
52
|
+
Requires-Dist: python-docx>=1.1
|
|
53
|
+
Requires-Dist: scrapling>=0.4.15
|
|
54
|
+
Requires-Dist: sqlite-vec>=0.1.6
|
|
55
|
+
Requires-Dist: textual>=1.0
|
|
56
|
+
Requires-Dist: typer>=0.15
|
|
57
|
+
Provides-Extra: browser
|
|
58
|
+
Requires-Dist: scrapling[fetchers]>=0.4.15; extra == 'browser'
|
|
59
|
+
Provides-Extra: dev
|
|
60
|
+
Requires-Dist: mypy>=1.14; extra == 'dev'
|
|
61
|
+
Requires-Dist: pytest-cov>=6.0; extra == 'dev'
|
|
62
|
+
Requires-Dist: pytest>=8.3; extra == 'dev'
|
|
63
|
+
Requires-Dist: respx>=0.22; extra == 'dev'
|
|
64
|
+
Requires-Dist: ruff>=0.9; extra == 'dev'
|
|
65
|
+
Provides-Extra: gpu
|
|
66
|
+
Requires-Dist: sentence-transformers>=3.3; extra == 'gpu'
|
|
67
|
+
Requires-Dist: torch>=2.5; extra == 'gpu'
|
|
68
|
+
Description-Content-Type: text/markdown
|
|
69
|
+
|
|
70
|
+
# proofpath
|
|
71
|
+
|
|
72
|
+
> Don't guess. Show the evidence.
|
|
73
|
+
|
|
74
|
+
`proofpath` checks whether the sources behind a claim actually say what the claim
|
|
75
|
+
says. Point it at a paper, a draft, or a link — it verifies every citation on three
|
|
76
|
+
levels and shows you the passage behind each verdict.
|
|
77
|
+
|
|
78
|
+
1. **Does the source exist?** — resolved against Crossref, OpenAlex, PubMed, arXiv.
|
|
79
|
+
2. **Is it still valid?** — checked against Retraction Watch.
|
|
80
|
+
3. **Does it support the claim?** — retrieval + entailment against the source text.
|
|
81
|
+
|
|
82
|
+
Most tools stop at step 1. Step 3 is the point.
|
|
83
|
+
|
|
84
|
+
Runs offline and free by default: no API key, no Docker, no server. Windows, Linux
|
|
85
|
+
and macOS.
|
|
86
|
+
|
|
87
|
+
## What it will not do
|
|
88
|
+
|
|
89
|
+
It does not pretend to be certain. Full text is openly available for well under half
|
|
90
|
+
of published citations, so many verdicts will honestly be *not enough information*,
|
|
91
|
+
and every report ends with its own coverage figures. A tool that sounds sure about
|
|
92
|
+
everything is the problem this one exists to fight.
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
uv tool install proofpath
|
|
96
|
+
|
|
97
|
+
proofpath # interactive TUI
|
|
98
|
+
proofpath check paper.pdf # one-shot report
|
|
99
|
+
proofpath check draft.md --format sarif
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Status
|
|
103
|
+
|
|
104
|
+
🚧 Design stage — no working code yet.
|
|
105
|
+
|
|
106
|
+
- [Design specification](docs/superpowers/specs/2026-09-10-proofpath-design.md) — what it does and the measurements behind each decision
|
|
107
|
+
- [Implementation plan](docs/superpowers/plans/2026-09-10-proofpath-implementation-plan.md) — phases, ordered by risk retired
|
|
108
|
+
- [Open items](docs/superpowers/OPEN-ITEMS.md) — what is unresolved, and what has not been verified yet
|
|
109
|
+
|
|
110
|
+
## License
|
|
111
|
+
|
|
112
|
+
MIT
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
proofpath/__init__.py,sha256=BB96TrYmUP0vus2Gv2Gvwg4GYHACMdKBQHn26wuwjGU,130
|
|
2
|
+
proofpath/cli.py,sha256=CIw2ClhgmWn-Mfhk-c05OKiEeGjei5mGNdQndTdUVAU,2036
|
|
3
|
+
proofpath/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
4
|
+
proofpath-0.0.1.dist-info/METADATA,sha256=iB-ipO5uLEiOpvhrq4eKiFnz29DPQH0Xd9P1B5w58Zs,4804
|
|
5
|
+
proofpath-0.0.1.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
|
|
6
|
+
proofpath-0.0.1.dist-info/entry_points.txt,sha256=xzMLK0xlS5ak2ey0auDvfWuUvISi6IMERFU6CY_7yXs,48
|
|
7
|
+
proofpath-0.0.1.dist-info/licenses/LICENSE,sha256=01PTKWT74vv8zKC2Ku0qdVD-Zfh81oHYfadKy0oGa40,1070
|
|
8
|
+
proofpath-0.0.1.dist-info/RECORD,,
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Yigit Erdogan
|
|
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.
|