resint 0.1.0__tar.gz

resint-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+.resint/
+*.sarif
+.DS_Store

resint-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

resint-0.1.0/PKG-INFO

@@ -0,0 +1,303 @@
+Metadata-Version: 2.5
+Name: resint
+Version: 0.1.0
+Summary: A linter for research papers.
+Project-URL: Homepage, https://github.com/ArjunSharma06/resint
+Project-URL: Issues, https://github.com/ArjunSharma06/resint/issues
+Project-URL: Contributing, https://github.com/ArjunSharma06/resint/blob/main/CONTRIBUTING.md
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: bibliography,latex,linter,meta-science,peer-review,reproducibility,research,static-analysis,statistics
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Text Processing :: Markup :: LaTeX
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# resint
+
+[![CI](https://github.com/ArjunSharma06/resint/actions/workflows/ci.yml/badge.svg)](https://github.com/ArjunSharma06/resint/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/resint)](https://pypi.org/project/resint/)
+[![Python](https://img.shields.io/pypi/pyversions/resint)](https://pypi.org/project/resint/)
+[![License](https://img.shields.io/badge/licence-Apache--2.0-blue)](LICENSE)
+
+**A linter for research papers.** It reads a paper the way a compiler reads
+code — and reports what does not add up.
+
+```console
+$ resint check paper.tex --repo ./code
+
+  high  ✓ numbers/internal-mismatch      Results:L23 <-> table1:r2c1:L35
+        Results reports accuracy of 94.2, but table1 reports 93.8 for the same
+        quantity (column holds 91.4, 93.8). A revised table with an unrevised
+        claim looks exactly like this.
+
+  high  ✓ repro/hparam-drift             Method:L13 <-> configs/base.yaml:L3
+        learning rate is 3e-4 in the paper, but a run would use 1e-4 from
+        configs/base.yaml. Resolved through argparse default in train.py
+        (3e-4) -> configs/base.yaml (1e-4).
+
+  high  ✓ repro/seed-claim               claim:L14 <-> train.py:L31
+        The paper reports results over 5 runs, but the repository fixes a
+        single seed (42) in 3 places and never varies it.
+        affects: every error bar downstream of this claim
+
+   med  ✓ bib/unresolved                 [zhang2023].doi:L18
+        The DOI 10.5555/9999999 does not resolve, and no index returned a
+        matching record.
+
+  11 findings (4 high, 5 med, 2 low) · 1.8s · no API key used
+```
+
+**No API key. No account. No dependencies.** Most of resint is arithmetic,
+parsing, and HTTP. It runs offline in about two seconds.
+
+---
+
+## Who it's for
+
+| | What you get |
+|---|---|
+| **Writing a paper** | Catch the inconsistencies before a reviewer does. Run it on your draft the way you run a spellchecker. |
+| **Submitting** | The stale abstract number, the citation that does not resolve, the config that no longer matches your methods section. |
+| **Reviewing** | A five-minute read of a submission's statistics and bibliography. Runs fully offline, so nothing confidential leaves your machine. |
+| **Reading** | Before you spend an afternoon on someone's repository, find out whether its numbers, links, and hyperparameters agree with the paper. |
+
+It works on any field. The statistics and bibliography rules assume nothing
+about your discipline; the `repro/` rules assume you have code.
+
+## Install
+
+```console
+pipx install resint      # Python 3.11+, no other dependencies
+```
+
+## Quickstart
+
+```console
+resint check paper.tex                       # the paper alone
+resint check paper.tex --repo ./code         # paper against its code
+resint check paper.tex --offline             # no network at all
+resint check paper.tex --format sarif        # GitHub code scanning
+resint rules                                 # what it checks, and what it misses
+resint init                                  # write a .resint.yml
+```
+
+Exits non-zero when a high-severity finding is present, so it drops into CI
+without a wrapper.
+
+---
+
+## What it checks
+
+```mermaid
+%%{init: {'theme':'base','themeVariables':{
+  'fontSize':'15px','textColor':'#15171d','primaryTextColor':'#15171d',
+  'lineColor':'#5b6472',
+  'cScale0':'#2b4acb','cScaleLabel0':'#ffffff','cScalePeer0':'#1e3596',
+  'cScale1':'#8fadf2','cScaleLabel1':'#0f1c3d','cScalePeer1':'#2b4acb',
+  'cScale2':'#6fc9a4','cScaleLabel2':'#0c2b20','cScalePeer2':'#1b7355',
+  'cScale3':'#e8b45c','cScaleLabel3':'#3a2405','cScalePeer3':'#a85800',
+  'cScale4':'#ef9a90','cScaleLabel4':'#3d100c','cScalePeer4':'#b7332a',
+  'cScale5':'#b79ae0','cScaleLabel5':'#241040','cScalePeer5':'#6b3fa0'
+}}}%%
+mindmap
+  root((resint))
+    numbers
+      internal-mismatch
+        abstract vs table
+      table-arithmetic
+        totals that don't total
+    stats
+      pvalue-mismatch
+        recompute p from the statistic
+      grim
+        means impossible for the N
+      significance-unsupported
+        reliable claims, no test
+    bib
+      unresolved
+        references in no index
+      metadata-drift
+        year or title disagrees
+      orphans
+        cited but undefined
+    repro
+      hparam-drift
+        paper vs effective config
+      seed-claim
+        five seeds, one seed
+      entrypoint-missing
+        README points at nothing
+      ghost-repo
+        no code, only promises
+      unpinned-deps
+        no record of the environment
+```
+
+| Rule | Catches | Needs |
+|---|---|---|
+| `numbers/internal-mismatch` | The abstract and the results table disagree about one value | |
+| `numbers/table-arithmetic` | Stated totals that do not equal the entries above them | |
+| `stats/pvalue-mismatch` | A reported *p* that the test statistic does not produce | |
+| `stats/grim` | A mean arithmetically impossible for the stated *N* | |
+| `stats/significance-unsupported` | Claims of reliability with no test anywhere in the paper | |
+| `bib/unresolved` | References that exist in no index — the fabricated-citation signal | network |
+| `bib/metadata-drift` | Entries whose year or title disagrees with the canonical record | network |
+| `bib/orphans` | Keys cited with no entry, entries never cited | |
+| `repro/hparam-drift` | The paper's hyperparameters against the ones a run would use | `--repo` |
+| `repro/seed-claim` | "Averaged over five seeds" when the code fixes one | `--repo` |
+| `repro/entrypoint-missing` | README commands pointing at files that do not exist | `--repo` |
+| `repro/ghost-repo` | A linked repository holding no code | `--repo` |
+| `repro/unpinned-deps` | Nothing recording the environment the results came from | `--repo` |
+
+`resint rules` prints each rule's blind spots. **Every rule declares what it
+cannot detect**, and that limitation travels with the finding into JSON and
+SARIF output.
+
+---
+
+## The two ideas
+
+### Findings are evidence, not opinions
+
+A finding says *"Results line 23 reports 94.2; table 1 row 2 column 1 reports
+93.8."* There is nothing left for you to verify.
+
+Every finding carries **at least two anchors**, enforced at construction — not
+by convention, by the type system:
+
+```python
+Finding(anchors=[claim_span])                    # raises AnchorError
+Finding(anchors=[claim_span, evidence_span])     # a comparison you can check
+```
+
+One anchor is an assertion you have to go and check. Two make it a comparison
+you can verify by reading the finding itself. That difference is the product.
+
+The `✓` marks a finding as **computed** rather than judged.
+
+### It tells you what it could not check
+
+*"No findings"* and *"did not look"* are different statements, and a tool that
+conflates them is worse than useless.
+
+```
+  unchecked: table3 not checked: row widths disagree ([3, 4])
+  unchecked: mean at line 57 not checked: 2 sample sizes in the same sentence
+  unchecked: 5 references could not be looked up (offline); not reported as missing
+```
+
+---
+
+## How it works
+
+```mermaid
+flowchart LR
+  A["paper.tex<br/>refs.bib<br/>./code"]:::io --> B["Parse"]:::step
+  B --> C[("IR<br/>typed, span-anchored")]:::ir
+  C --> D{"Rules"}:::step
+  D -->|deterministic| E["Findings"]:::out
+  D -.->|model-assisted<br/>optional| E
+  E --> F["term · json · sarif"]:::io
+
+  classDef io fill:#f4f5f8,stroke:#c9cdd8,color:#15171d
+  classDef step fill:#ffffff,stroke:#8a91a3,color:#15171d
+  classDef ir fill:#e7eafa,stroke:#2b4acb,color:#15171d,font-weight:bold
+  classDef out fill:#e4f1eb,stroke:#1b7355,color:#15171d,font-weight:bold
+```
+
+Every character of the intermediate representation remembers where it came
+from, so a finding that says `line 98` means line 98 of *your* file.
+
+Rules declare what they need, and the engine builds only that. A run whose
+rules never declare `paper.resolutions` **never opens a socket** — laziness is
+the privacy mechanism, not a separate flag.
+
+---
+
+## Precision over coverage
+
+A rule that stays silent one time in five where it should have spoken is a
+good rule. A rule that speaks wrongly one time in twenty is a liability. This
+tool tells people something is wrong with their work, and a single confident
+false accusation costs more trust than a hundred correct findings earn.
+
+So resint abstains — loudly — wherever it cannot be sure:
+
+- A mean is checked only when **exactly one** sample size sits in its sentence.
+- A reference is reported missing only when the indices were actually reached.
+  **A lookup that fails is never a finding.**
+- A prose value is compared to a table cell only when it is *near* one. A
+  distant value is a different quantity, not a stale number.
+- A hyperparameter is compared only when the repository yields **one**
+  effective value. Two configs disagreeing at the same precedence level means
+  a run's actual value cannot be known.
+- A seed read from an argument or set inside a loop counts as varying, even
+  though the source shows one call.
+- A table whose grid did not parse is skipped and reported, never guessed at.
+
+---
+
+## Configuration
+
+```yaml
+# .resint.yml
+suppress:
+  - rule: bib/metadata-drift
+    match: "[vaswani2017]"
+    reason: "Cites the proceedings version deliberately."
+    expires: "2027-01-01"
+
+rules:
+  stats/grim: off        # no integer-scale response data in this work
+```
+
+**Every suppression states a reason.** This file is the record of each
+judgement made about the work, and a silenced finding with no explanation is
+unauditable six months later. Suppressed findings still appear in JSON and
+SARIF marked with their reason, so a suppression can never hide a regression.
+
+## Privacy
+
+resint runs entirely on your machine. The only network access is reference
+resolution, which sends the **titles and DOIs of works your paper already
+cites publicly**. The manuscript itself is never transmitted. `--offline`
+disables even that, and the reference rules abstain rather than guess.
+
+---
+
+## Documentation
+
+| | |
+|---|---|
+| [docs/rules.md](docs/rules.md) | Every rule, what it catches, what it cannot detect |
+| [docs/architecture.md](docs/architecture.md) | The IR, the rule engine, the pipeline |
+| [docs/configuration.md](docs/configuration.md) | `.resint.yml` in full |
+| [docs/rule-authoring.md](docs/rule-authoring.md) | How to write a rule, and the bar it has to clear |
+| [CHANGELOG.md](CHANGELOG.md) | What shipped, when |
+
+## Status
+
+**Early — v0.1.** Thirteen of eighteen planned rules are implemented and
+tested. The API is not stable yet.
+
+Next: `repro/dead-asset`, and the model-assisted tier (`claim/`, `eval/`) —
+which checks whether the code implements what the paper claims. That tier
+needs a provider and stays **optional**; everything above runs with no key.
+
+Found a false positive? [That's the most valuable issue you can
+open](https://github.com/ArjunSharma06/resint/issues) — each one becomes a
+regression fixture.
+
+## Licence
+
+Apache-2.0.